health cloud object reference guide - salesforce.com cloud object reference guide editions ... •...
TRANSCRIPT
Health Cloud Object ReferenceGuide
Salesforce, Spring ’17
@salesforcedocsLast updated: March 24, 2017
© Copyright 2000–2017 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
HEALTH CLOUD OBJECT REFERENCE GUIDE . . . . . . . . . . . . . . . . . . . . . . . . . . 1
CUSTOM FIELDS ON STANDARD OBJECTS . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Account Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Contact Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Lead Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Task Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
ELECTRONIC HEALTH RECORD CUSTOM OBJECTS . . . . . . . . . . . . . . . . . . . 23EhrAllergyIntolerance__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23EhrCarePlan__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29EhrCarePlanActivity__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32EhrCarePlanConcern__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40EhrCarePlanGoal__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42EhrCarePlanParticipant__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45EhrCondition__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48EhrConditionRelatedItem__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57EhrDevice__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60EhrDosageInstruction__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65EhrEncounter__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74EhrEncounterAccommodation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103EhrEncounterParticipant__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106EhrImmunization__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109EhrImmunizationReaction__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119EhrMedicationPrescription__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122EhrMedicationStatement__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133EhrObservation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139EhrPatient__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153EhrPatientCareProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176EhrPatientContact__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179EhrPractitioner__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199EhrPractitionerIdentity__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238EhrPractitionerQualification__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242EhrPractitionerRole__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245EhrRelatedObservation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250EhrRelatedPerson__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253EhrVaccinationProtocol__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274EhrVirtualDevice__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278EhrVirtualDeviceChannel__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
HEALTH CLOUD CUSTOM OBJECTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285CarePlanTemplate__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285CarePlanTemplateGoal__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286CarePlanTemplateProblem__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287CarePlanTemplateTask__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289AccountAccountRelation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291CandidatePatient__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293CardViewDropdown__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316CarePlanGoal__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317CarePlanGoal__History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320CarePlanProblem__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321CarePlanProblem__History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322ConditionToHCCCodeMapping__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323ContactContactRelation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325CrossObjectRelationship__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327CustomFieldSets__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329CustomLabelConfig__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330FilterColumn__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331FilterCondition__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333FilterCriterion__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335PatientCardViewConfiguration__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Program__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339ProgramPatientAffiliation__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341ProgramPatientSummary__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Provider__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346TimelineViewConfiguration__c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
HEALTH CLOUD CUSTOM METADATA TYPES . . . . . . . . . . . . . . . . . . . . . . . 351GroupRecordTypeMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351IndividualRecordTypeMapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351RiskScoreAgeBandContinuedEnrollee . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353RiskScoreAgeBandNewEnrollee . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356RiskScoreHCCCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358RiskScoreDiseaseInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361RiskScoreMedicaidInteractions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363HealthCloudSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Contents
HEALTH CLOUD OBJECT REFERENCE GUIDE
EDITIONS
Health Cloud is available inSalesforce Classic
Available in: Enterprise,Performance, andUnlimited Editions
This guide provides information on the custom objects used by Health Cloud and their fields. Somefields may not be listed for some objects.
To see the standard objects used by Salesforce, see the Object Reference for Salesforce. To verify thecomplete list of fields for an object, you can use a describe call from the API, or inspect with anappropriate tool, for example, inspecting the WSDL or using a schema viewer.
1
CUSTOM FIELDS ON STANDARD OBJECTS
Account Custom Fields
Custom fields extend the standard Account object for use in Health Cloud to represent information about an individual.
Fields
DetailsField
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionRefers to Case object. This field is the lookup to the care plan.
Typestring
IndividualId__c
PropertiesFilter, Nillable, Sort
DescriptionIdentifier for the individual.
Typestring
IndividualType__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionIdentifier for the individual.
Typestring
MedicalRecordNumber__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe medical record number used to identify a patient.
Typereference
PrimaryContact__c
2
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort
DescriptionRefers to Contact object.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, NillableSort
DescriptionThe ID of an external record. This field can’t be encrypted.
Contact Custom Fields
Custom fields extend the standard Contact object for use in Health Cloud to represent information about an individual.
Fields
DetailsField
Typestring
Age__c
PropertiesFilter, Nillable, Sort
DescriptionAge. Calculated from Contact.Birthdate.
Typestring
BirthDate__c
PropertiesFilter, Nillable, Sort
DescriptionDate of birth.
Typepicklist
CountryOfBirth__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
DescriptionIndividual’s country of birth.
3
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
Valid values:
• Afghanistan
• Aland Islands
• Albania
• Algeria
• Andorra
• Angola
• Anguilla
• Antarctica
• Antigua and Barbuda
• Argentina
• Armenia
• Aruba
• Australia
• Austria
• Azerbaijan
• Bahamas
• Bahrain
• Bangladesh
• Barbados
• Belarus
• Belgium
• Belize
• Benin
• Bermuda
• Bhutan
• Bolivia, Plurinational State of
• Bonaire, Sint Eustatius and Saba
• Bosnia and Herzegovina
• Botswana
• Bouvet Island
• Brazil
• British Indian Ocean Territory
• Brunei Darussalam
• Bulgaria
• Burkina Faso
• Burundi
• Cambodia
4
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Cameroon
• Canada
• Cape Verde
• Cayman Islands
• Central African Republic
• Chad
• Chile
• China
• Christmas Island
• Cocos (Keeling) Islands
• Colombia
• Comoros
• Congo
• Congo, the Democratic Republic of the
• Cook Islands
• Costa Rica
• Cote d’Ivoire
• Croatia
• Cuba
• Curaçao
• Cyprus
• Czech Republic
• Denmark
• Djibouti
• Dominica
• Dominican Republic
• Ecuador
• Egypt
• El Salvador
• Equatorial Guinea
• Eritrea
• Estonia
• Ethiopia
• Falkland Islands (Malvinas)
• Faroe Islands
• Fiji
• Finland
• France
5
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• French Guiana
• French Polynesia
• French Southern Territories
• Gabon
• Gambia
• Georgia
• Germany
• Ghana
• Gibraltar
• Greece
• Greenland
• Grenada
• Guadeloupe
• Guatemala
• Guernsey
• Guinea
• Guinea-Bissau
• Guyana
• Haiti
• Heard Island and McDonald Islands
• Holy See (Vatican City State)
• Honduras
• Hungary
• Iceland
• India
• Indonesia
• Iran, Islamic Republic of
• Iraq
• Ireland
• Isle of Man
• Israel
• Italy
• Jamaica
• Japan
• Jersey
• Jordan
• Kazakhstan
• Kenya
6
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Kiribati
• Korea, Democratic People’s Republic of
• Korea, Republic of
• Kuwait
• Kyrgyzstan
• Lao People’s Democratic Republic
• Latvia
• Lebanon
• Lesotho
• Liberia
• Libyan Arab Jamahiriya
• Liechtenstein
• Lithuania
• Luxembourg
• Macao
• Macedonia, the former Yugoslav Republic of
• Madagascar
• Malawi
• Malaysia
• Maldives
• Mali
• Malta
• Martinique
• Mauritania
• Mauritius
• Mayotte
• Mexico
• Moldova, Republic of
• Monaco
• Mongolia
• Montenegro
• Montserrat
• Morocco
• Mozambique
• Myanmar
• Namibia
• Nauru
• Nepal
7
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Netherlands
• New Caledonia
• New Zealand
• Nicaragua
• Niger
• Nigeria
• Niue
• Norfolk Island
• Norway
• Oman
• Pakistan
• Palestine
• Panama
• Papua New Guinea
• Paraguay
• Peru
• Philippines
• Pitcairn
• Poland
• Portugal
• Qatar
• Reunion
• Romania
• Russian Federation
• Rwanda
• Saint Barthélemy
• Saint Helena, Ascension and Tristan da Cunha
• Saint Kitts and Nevis
• Saint Lucia
• Saint Martin (French part)
• Saint Pierre and Miquelon
• Saint Vincent and the Grenadines
• Samoa
• San Marino
• Sao Tome and Principe
• Saudi Arabia
• Senegal
• Serbia
8
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Seychelles
• Sierra Leone
• Singapore
• Sint Maarten (Dutch part)
• Slovakia
• Slovenia
• Solomon Islands
• Somalia
• South Africa
• South Georgia and the South Sandwich Islands
• South Sudan
• Spain
• Sri Lanka
• Sudan
• Suriname
• Svalbard and Jan Mayen
• Swaziland
• Sweden
• Switzerland
• Syrian Arab Republic
• Taiwan
• Tajikistan
• Tanzania, United Republic of
• Thailand
• Timor-Leste
• Togo
• Tokelau
• Tonga
• Trinidad and Tobago
• Tunisia
• Turkey
• Turkmenistan
• Turks and Caicos Islands
• Tuvalu
• Uganda
• Ukraine
• United Arab Emirates
• United Kingdom
9
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• United States
• Uruguay
• Uzbekistan
• Vanuatu
• Venezuela, Bolivarian Republic of
• Vietnam
• Virgin Islands, British
• Wallis and Futuna
• Western Sahara
• Yemen
• Zambia
• Zimbabwe
Typeboolean
CreatedFromLead__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the individual was created from a converted lead (true) or not (false).
Typepicklist
Gender__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionGender. Valid values:
• Female
• Male
• Decline to Specify
• Other
Typestring
IndividualId__c
PropertiesFilter, Nillable, Sort
DescriptionIdentifier for the individual.
Typepicklist
IndividualType__c
10
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionType of individual. Valid values:
• Individual
Typestring
MedicalRecordNumber__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe medical record number used to identify a patient.
Typestring
PreferredName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionIndividual’s preferred name.
Typepicklist
PrimaryLanguage__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionIndividual’s primary language.
Valid values:
• Abkhaz
• Adyghe
• Afrikaans
• Akan
• Albanian
• American Sign Language
• Amharic
• Ancient Greek
• Arabic
• Aragonese
• Aramaic
• Armenian
• Aymara
11
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Balinese
• Basque
• Betawi
• Bosnian
• Breton
• Bulgarian
• Cantonese
• Catalan
• Cherokee
• Chickasaw
• Chinese
• Coptic
• Cornish
• Corsican
• Crimean Tatar
• Croatian
• Czech
• Danish
• Dawro
• Dutch
• English
• Esperanto
• Estonian
• Ewe
• Fiji Hindi
• Filipino
• Finnish
• French
• Galician
• Georgian
• German
• Greek, Modern
• Greenlandic
• Haitian Creole
• Hawaiian
• Hebrew
• Hindi
• Hungarian
12
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Icelandic
• Indonesian
• Interlingua
• Inuktitut
• Irish
• Italian
• Japanese
• Javanese
• Kabardian
• Kalasha
• Kannada
• Kashubian
• Khmer
• Kinyarwanda
• Korean
• Kurdish/Kurdî
• Ladin
• Latgalian
• Latin
• Lingala
• Livonian
• Lojban
• Low German
• Lower Sorbian
• Macedonian
• Malay
• Malayalam
• Mandarin
• Manx
• Maori
• Mauritian Creole
• Middle Low German
• Min Nan
• Mongolian
• Norwegian
• Oriya
• Pangasinan
• Papiamentu
13
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Pashto
• Persian
• Pitjantjatjara
• Polish
• Portuguese
• Proto-Slavic
• Quenya
• Rapa Nui
• Romanian
• Russian
• Sanskrit
• Scots
• Scottish Gaelic
• Serbian
• Serbo-Croatian
• Sinhalese
• Slovak
• Slovene
• Spanish
• Swahili
• Swedish
• Tagalog
• Tajik
• Tamil
• Tarantino
• Telugu
• Thai
• Tok Pisin
• Turkish
• Twi
• Ukrainian
• Upper Sorbian
• Urdu
• Uzbek
• Venetian
• Vietnamese
• Vilamovian
• Volapük
14
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Võrro
• Welsh
• Xhosa
• Yiddish
• Zazaki
Typepicklist
SecondaryLanguage__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionIndividual’s secondary language.
Valid values:
• Abkhaz
• Adyghe
• Afrikaans
• Akan
• Albanian
• American Sign Language
• Amharic
• Ancient Greek
• Arabic
• Aragonese
• Aramaic
• Armenian
• Aymara
• Balinese
• Basque
• Betawi
• Bosnian
• Breton
• Bulgarian
• Cantonese
• Catalan
• Cherokee
• Chickasaw
• Chinese
• Coptic
• Cornish
15
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Corsican
• Crimean Tatar
• Croatian
• Czech
• Danish
• Dawro
• Dutch
• English
• Esperanto
• Estonian
• Ewe
• Fiji Hindi
• Filipino
• Finnish
• French
• Galician
• Georgian
• German
• Greek, Modern
• Greenlandic
• Haitian Creole
• Hawaiian
• Hebrew
• Hindi
• Hungarian
• Icelandic
• Indonesian
• Interlingua
• Inuktitut
• Irish
• Italian
• Japanese
• Javanese
• Kabardian
• Kalasha
• Kannada
• Kashubian
• Khmer
16
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Kinyarwanda
• Korean
• Kurdish/Kurdî
• Ladin
• Latgalian
• Latin
• Lingala
• Livonian
• Lojban
• Low German
• Lower Sorbian
• Macedonian
• Malay
• Malayalam
• Mandarin
• Manx
• Maori
• Mauritian Creole
• Middle Low German
• Min Nan
• Mongolian
• Norwegian
• Oriya
• Pangasinan
• Papiamentu
• Pashto
• Persian
• Pitjantjatjara
• Polish
• Portuguese
• Proto-Slavic
• Quenya
• Rapa Nui
• Romanian
• Russian
• Sanskrit
• Scots
• Scottish Gaelic
17
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
• Serbian
• Serbo-Croatian
• Sinhalese
• Slovak
• Slovene
• Spanish
• Swahili
• Swedish
• Tagalog
• Tajik
• Tamil
• Tarantino
• Telugu
• Thai
• Tok Pisin
• Turkish
• Twi
• Ukrainian
• Upper Sorbian
• Urdu
• Uzbek
• Venetian
• Vietnamese
• Vilamovian
• Volapük
• Võrro
• Welsh
• Xhosa
• Yiddish
• Zazaki
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Unique, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
18
Contact Custom FieldsCustom Fields on Standard Objects
DetailsField
Typestring
SourceSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn external data source.
Lead Custom Fields
Custom fields extend the standard Lead object for use in Health Cloud to represent information about an incoming patient.
Supported Callscreate()delete(), describeLayout(), getDeleted(), getUpdated(), merge()query(), retrieve(),search(), undelete(), update(), upsert(),
Fields
DetailsField
Typereference
AssignCareCoordinatorContact__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to Contact object. If populated and the AssignCareCoordinatorUser__c field is blank,assigns the care coordinator role based on the contact record.
Typereference
AssignCareCoordinatorUser__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to User object. If populated, assigns the care coordinator role based on the user record.
Typedate
BirthDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
19
Lead Custom FieldsCustom Fields on Standard Objects
DetailsField
DescriptionThe patient’s birthdate.
Typeboolean
CreatedFromLead__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the individual was created from a converted lead (true) or not (false).
Typestring
CurrentGenerators__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionRefers to Case object. This field is the lookup to the care plan.
Typeboolean
IsMarkedForPatientConversion__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the lead will be converted to a patient record.
Typestring
MedicalRecordNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe medical record number used to identify a patient.
Typedouble
NumberofLocations__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionNumber of locations associated with the lead.
Typepicklist
Primary__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
20
Lead Custom FieldsCustom Fields on Standard Objects
DetailsField
DescriptionIndicates whether the individual is the primary member of the household (true) or not(false).
Typepicklist
ProductInterest__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionPicklist field to track interest in the product.
Typestring
SICCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionStandard Industrial Classification code.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionThe system that created the record and owns updating rights for it.
Task Custom Fields
Custom fields extend the standard Task object for use in Health Cloud to represent information about an individual.
21
Task Custom FieldsCustom Fields on Standard Objects
Fields
DetailsField
Typereference
CarePlanGoal__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionRepresents the intended objectives of carrying out a care plan.
Typereference
CarePlanProblem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionRepresents the conditions, problems, concerns, diagnoses, and so on, whose managementand mitigation are handled by this plan.
Typepicklist
TaskType__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe list of healthcare-related tasks configured in the org.
22
Task Custom FieldsCustom Fields on Standard Objects
ELECTRONIC HEALTH RECORD CUSTOM OBJECTS
EhrAllergyIntolerance__c
Represents information about the patient’s susceptibility to an adverse reaction upon exposure to a specified substance.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
Typestring
CriticalityCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.
Typestring
CriticalityLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.
Typestring
CriticalitySystem__c
23
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines an estimate of the potential clinical harm or seriousness of thereaction to the identified substance.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
24
EhrAllergyIntolerance__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookupSort
DescriptionThe EHR allergy intolerance ID. Limit: 255 characters.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient who has the sensitivity. Lookup to EhrPatient__c.
Typestring
Reaction255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the allergic reaction, including details of the manifestation if required. Limit:255 characters.
Typetextarea
Reaction__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of the allergic reaction, including details of the manifestation ifrequired.
TypedateTime
RecordedDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when the sensitivity was recorded.
Typestring
RecorderName255__c
25
EhrAllergyIntolerance__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the individual who recorded the record and takes responsibility for its content.Limit: 255 characters.
Typetextarea
RecorderName__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the name of the individual who recorded the record and takesresponsibility for its content.
Typereference
Recorder__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe individual who takes responsibility for the content and can reference its source. Lookupto EhrPractitioner__c.
Typereference
SensitivityTest1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.
Typereference
SensitivityTest2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.
Typereference
SensitivityTest3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.
26
EhrAllergyIntolerance__cElectronic Health Record Custom Objects
DetailsField
Typestring
SensitivityTypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the patient’s sensitivity.
Typestring
SensitivityTypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the patient’s sensitivity
Typestring
SensitivityTypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the patient’s sensitivity
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
27
EhrAllergyIntolerance__cElectronic Health Record Custom Objects
DetailsField
Typestring
StatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.
Typestring
StatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.
Typestring
StatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the level of certainty associated with the potential risk of a reactionto the identified substance.
Typestring
Substance255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe substance or class of substances that’s considered responsible for the adverse reactionrisk. Limit: 255 characters.
Typetextarea
SubstanceLong__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the substance or class of substances that’s considered responsiblefor the adverse reaction risk.
28
EhrAllergyIntolerance__cElectronic Health Record Custom Objects
EhrCarePlan__c
Represents how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care fora specific condition or set of conditions.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe individual account that represents the patient in Force.com.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
29
EhrCarePlan__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR care plan ID. Limit: 255 characters.
Typetextarea
Notes__c
PropertiesCreate, Nillable, Update
DescriptionNotes about the execution of the activity.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.
TypedateTime
PeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when the plan is in effect.
30
EhrCarePlan__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
PeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the plan comes (or is intended to come) into effect.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Status__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionWhether the plan is currently being acted upon, represents future intentions, or is onlyhistorical record.
UsageThis resource captures basic details about who’s involved in the care plan and what actions are intended without dealing in discretedata about dependencies and timing relationships.
31
EhrCarePlan__cElectronic Health Record Custom Objects
EhrCarePlanActivity__c
Represents a planned action to occur as part of a care plan. Examples include a medication to be used, lab tests to perform, and education.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typetextarea
ActionsResulting__c
PropertiesCreate, Nillable, Update
DescriptionResources that describe follow-on actions resulting from the care plan, such as drugprescriptions, encounter records, and appointments.
Typestring
ActivityPeriod__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe period when the described activity is to occur.
Typestring
ActivitySchedule__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionWhen the described activity is scheduled to occur.
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort,
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
32
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
Typestring
Category__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA high-level categorization of the type of activity in a care plan.
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a detailed description of the type of planned activity.Examples of activity types include what lab test, what procedure, and what kind of encounter.
Typestring
CodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a detailed description of the type of plannedactivity. Examples of activity types include what lab test, what procedure, and what kind ofencounter.
Typestring
CodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a detailed description of the type of planned activity. Examples ofactivity types include what lab test, what procedure, and what kind of encounter.
Typestring
DailyAmount__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe quantity expected to be consumed in a given day.
Typetextarea
Details__c
33
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionA summary of a planned activity suitable for a general care plan system that doesn’t knowabout specific resources such as procedure.
Typeboolean
IsProhibited__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the described activity must not be engaged in when following the plan (true) orcan be engaged in when following the plan (false). The default checkbox value isunselected.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
34
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
LocationId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the facility where the activity will occur. Examples of locationsinclude home, hospital, and specific clinic.
Typestring
LocationLine1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the facility where the activity will occur.
Typestring
LocationLine2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the facility where the activity will occur.
Typestring
LocationName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the facility where the activity will occur. Examples of locations include home,hospital, and specific clinic.
Typestring
LocationPostalCode__c
35
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the facility where the activity will occur.
TypedateTime
LocationStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as the facility where the activity will occur.
Typestring
LocationState__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the facility where the activity will occur.
Typestring
LocationTelecom__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA contact detail for the facility where the activity will occur.
Typetextarea
LocationText__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the facility where the activity will occur.
Typestring
LocationType__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the activity will occur.
Typestring
LocationUse__c
36
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to the facility where the activity will occur.
Typestring
Name
PropertiesAutonumber, Defaulted on create , Filter, idLookup, Sort
DescriptionThe EHR care plan activity ID. Limit: 255 characters.
Typetextarea
Notes__c
PropertiesCreate, Nillable, Update
DescriptionNotes about the execution of the activity.
Typestring
ProductMedication255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe drug to be consumed or supplied in the activity. Limit: 255 characters.
Typetextarea
ProductMedication__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the drug to be consumed or supplied in the activity.
Typestring
ProductSubstance255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA homogeneous material with a definite composition. Limit: 255 characters.
Typetextarea
ProductSubstance__c
37
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionThe long text description of a homogeneous material with a definite composition.
Typestring
Quantity__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe quantity expected to be supplied, administered, or consumed.
Typereference
RelatedCarePlanGoal1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.
Typereference
RelatedCarePlanGoal2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.
Typereference
RelatedCarePlanGoal3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.
Typereference
RelatedCarePlanGoal4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.
Typereference
RelatedCarePlanGoal5__c
38
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.
Typereference
RelatedEncounter__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related interaction between a patient and one or more healthcare providers for the purposeof providing the patient with healthcare services or assessing a patient’s health status. Lookupto EhrEncounter__c.
Typereference
RelatedMedicationPrescription__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA related order for supply of a medication and the instructions for administration of themedicine to a patient. Lookup to EhrMedicationPrescription__c.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Status__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn indicator of the progress being made by the specific activity.
39
EhrCarePlanActivity__cElectronic Health Record Custom Objects
DetailsField
Typestring
TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the type of activity in a care plan.
Typestring
TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of activity in a care plan.
Typestring
TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of activity in a care plan.
EhrCarePlanConcern__c
Represents the conditions, problems, concerns, diagnoses, and so on, whose management and mitigation are handled by this plan.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort
40
EhrCarePlanConcern__cElectronic Health Record Custom Objects
DetailsField
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
Typereference
CarePlanGoal__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe intended objectives of carrying out the care plan.
Typereference
Condition__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe problems and diagnoses recognized by a clinician. Lookup to EhrCondition__c.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
41
EhrCarePlanConcern__cElectronic Health Record Custom Objects
DetailsField
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR care plan concern ID. Limit: 255 characters.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrCarePlanGoal__c
Represents the intended objectives of carrying out the care plan.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort
42
EhrCarePlanGoal__cElectronic Health Record Custom Objects
DetailsField
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
Typetextarea
Description__c
PropertiesCreate, Nillable, Update
DescriptionA description of the care plan goal.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
43
EhrCarePlanGoal__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookupSort
DescriptionThe EHR care plan goal ID. Limit: 255 characters.
Typetextarea
Notes__c
PropertiesCreate, Nillable, Update
DescriptionComments about the care plan goal.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Status__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
44
EhrCarePlanGoal__cElectronic Health Record Custom Objects
DetailsField
DescriptionWhether the plan is currently being acted upon, represents future intentions, or is onlyhistorical record.
EhrCarePlanParticipant__c
Represents people and organizations who are expected to be involved in the care envisioned by a care plan.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
Typereference
CarePlanActivity__c
PropertiesCreate, Filter, Group, Sort
DescriptionA planned action to occur as part of the plan. Examples include a medication to be used, labtests to perform, and education.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
45
EhrCarePlanParticipant__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR care plan participant ID. Limit: 255 characters.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
46
EhrCarePlanParticipant__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.
Typestring
Practitioner255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA person who’s involved in the providing of healthcare. Limit: 255 characters.
Typereference
Practitioner__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA person who’s involved in the providing of healthcare. Lookup to EhrPractitioner__c.
Typetextarea
PractitionerName__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the name of a person who’s involved in the providing ofhealthcare.
Typereference
RelatedPerson__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’thave a formal responsibility in the process. Lookup to EhrRelatedPerson__c.
Typestring
RoleCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the specific responsibility of an individual withinthe care plan. Examples of roles include primary physician, team coordinator, and caregiver.
47
EhrCarePlanParticipant__cElectronic Health Record Custom Objects
DetailsField
Typestring
RoleLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the specific responsibility of an individual withinthe care plan. Examples of roles include primary physician, team coordinator, and caregiver.
Typestring
RoleSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the specific responsibility of an individual within the care plan.Examples of roles include primary physician, team coordinator, and caregiver.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrCondition__c
Represents detailed information about conditions, problems, and diagnoses recognized by a clinician.
48
EhrCondition__cElectronic Health Record Custom Objects
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
AbatementDetail255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date or estimated date when the condition was resolved or went into remission. Limit:255 characters.
Typestring
AbatementDetail__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the date or estimated date when the condition was resolved orwent into remission.
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort,
DescriptionThe individual account that represents the patient in Force.com.
Typestring
AsserterPatient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe person who asserts the condition.
Typestring
AsserterPractitioner__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
49
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe person reporting the condition.
Typestring
CategoryCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the category that’s assigned to the condition.Examples of categories are complaint, symptom, and diagnosis.
Typestring
CategoryLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the category that’s assigned to the condition.Examples of categories are complaint, symptom, and diagnosis.
Typestring
CategorySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the category that’s assigned to the condition. Examples of categoriesare complaint, symptom, and diagnosis.
Typestring
CertaintyCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents level of confidence that the condition is correct.
Typestring
CertaintyLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the certainty of a correct condition.
50
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
Typestring
CertaintySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the certainty.
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the condition, problem, or diagnosis.
Typestring
CodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the condition, problem, or diagnosis.
Typestring
CodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the condition, problem, or diagnosis.
TypedateTime
DateAsserted__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe estimated or actual date when the condition, problem, or diagnosis was first detectedor suspected.
Typereference
Encounter__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
51
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe encounter during which the condition was first asserted. Lookup to EhrEncounter__c.
Typestring
EvidenceCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the manifestation or symptom that led to therecording of this condition. Evidence can be a simple list of coded symptoms ormanifestations, or references to observations or formal assessments, or both.
Typetextarea
EvidenceDetail__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of supporting information such as pathology reports.
Typestring
EvidenceLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the manifestation or symptom that led to therecording of this condition. Evidence can be a simple list of coded symptoms ormanifestations, or references to observations or formal assessments, or both.
Typestring
EvidenceSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the manifestation or symptom that led to the recording of thiscondition. Evidence can be a simple list of coded symptoms or manifestations, or referencesto observations or formal assessments, or both.
Typeboolean
IsAbated__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
52
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
DescriptionWhether the condition is resolved or in remission (true) or not (false). The defaultcheckbox value is deselected.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
53
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
Typestring
LocationCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the anatomical location where the condition ismanifested.
Typetextarea
LocationDetail__c
PropertiesCreate, Nillable, Update
DescriptionA long text description with precise details about the anatomical location where the conditionis manifested.
Typestring
LocationLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the anatomical location where the condition ismanifested.
Typestring
LocationSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the anatomical location where the condition is manifested.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR condition ID. Limit: 255 characters.
Typetextarea
Notes__c
PropertiesCreate, Nillable, Update
54
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
DescriptionAdditional information about the condition, including general comments about thedescription of the condition, its diagnosis, and prognosis.
Typestring
Onset__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe estimated or actual date or date-time when the condition began, in the clinician’sopinion. Age is typically used when the patient reports an age when the condition began.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient’s name. Lookup to EhrPatient__c.
Typestring
SeverityCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a subjective assessment of the condition’s severityas evaluated by the clinician. Where possible, coding of the severity with a terminology ispreferred.
Typestring
SeverityLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a subjective assessment of the condition’s severityas evaluated by the clinician. Where possible, coding of the severity with a terminology ispreferred.
Typestring
SeveritySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
55
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines a subjective assessment of the condition’s severity as evaluated bythe clinician Where possible, coding of the severity with a terminology is preferred.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Stage__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA condition’s clinical stage or grade, including a summary (such as “Stage 3”) or assessment(a reference to a formal record of the evidence on which the staging assessment is based).The determination of the stage is disease-specific. Can include formal severity assessments.
Typestring
StatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the condition’s clinical status.
56
EhrCondition__cElectronic Health Record Custom Objects
DetailsField
Typestring
StatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the condition’s clinical status.
Typestring
StatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the condition’s clinical status.
UsageUses include recording a diagnosis during an encounter and populating a problem list or summary statement, such as a dischargesummary.
EhrConditionRelatedItem__c
Represents an item that’s related to a patient’s conditions, problems, or diagnoses recognized by a clinician.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the item related to the patient’s condition.
Typestring
CodeLabel__c
57
EhrConditionRelatedItem__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the item related to the patient’s condition.
Typestring
CodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the item related to the patient’s condition.
Typereference
Condition__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe patient’s problem or diagnosis recognized by a clinician.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
58
EhrConditionRelatedItem__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typereference
MedicationStatement__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA record of the medication that the patient takes or that was given to the patient,where therecord is the result of a report from the patient or another clinician. Lookup toEhrMedicationStatement__c.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe EHR condition name. Limit: 255 characters.
Typetextarea
Notes__c
PropertiesCreate, Nillable, Update
DescriptionAdditional information about the item related to the patient’s condition.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
59
EhrConditionRelatedItem__cElectronic Health Record Custom Objects
DetailsField
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
TargetCondition__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to EhrCondition__c.
Typetextarea
TargetDetail__c
PropertiesCreate, Nillable, Update
Description
Typereference
TargetImmunization__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to EhrImmunization__c.
EhrDevice__c
Represents a manufactured item that’s used in the providing of healthcare without being substantially changed through that activity.Examples include machines, inserts, computers, and applications. Devices can be durable (reusable) medical equipment or disposableequipment used for diagnostic, treatment, and research for healthcare.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
60
EhrDevice__cElectronic Health Record Custom Objects
Fields
DetailsField
Typetextarea
Contact__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of the contact details for an organization or person who’s responsiblefor support for the device.
Typetextarea
DeviceURL__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of the network address on which the device can be directly contacted.
Typedate
Expiry__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date and time after which this device is not valid or should not be used.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
61
EhrDevice__cElectronic Health Record Custom Objects
DetailsField
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Location255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionWhere the device is found. Can be a literal location (for example, GPS coordinates), a logicalplace (for example, “with the patient”), or a coded location. Limit: 255 characters.
Typetextarea
Location__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of where the device is found. Can be a literal location (for example,GPS coordinates), a logical place (for example, “with the patient”), or a coded location.
Typestring
LotNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA lot number assigned by the manufacturer.
62
EhrDevice__cElectronic Health Record Custom Objects
DetailsField
Typestring
Manufacturer__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the device’s manufacturer.
Typestring
Model__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn identifier that’s assigned by the manufacturer to identify the product by its type. Thisnumber is shared by the all devices that are sold as the same type.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR device ID. Limit: 255 characters.
Typestring
Owner255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization that’s responsible for the provision and maintenance of the device. Limit:255 characters.
Typetextarea
Owner__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization that’s responsible for the provision andmaintenance of the device.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
63
EhrDevice__cElectronic Health Record Custom Objects
DetailsField
Description
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient’s name. Lookup to EhrPatient__c.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of device.
Typestring
Udi__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe United States Food and Drug Administration-mandated Unique Device Identifier (UDI).Use the human-readable information (the content that the user sees, which sometimesdiffers from the syntax in the barcode). The unique identifier can identify an instance of adevice uniquely or just identify the type of the device. The DI part can be extracted from theUDI when required and used to find information about the device through the GUDID.
64
EhrDevice__cElectronic Health Record Custom Objects
DetailsField
Typestring
Version__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe version of the device, if the device has multiple releases under the same model, issoftware, or carries firmware.
UsageThis resource is typically used to record which device performed an action and to track device location. It’s also used for prescribing anddispensing devices for patient use. If the device is implanted in a patient, the patient element is present, and there’s no location.
EhrDosageInstruction__c
Represents instructions for how a medication is to be used by a patient.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
AdditionalInstruction__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAdditional dosage instructions such as “Take with food.”
Typestring
AdditionalInstructionCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents additional dosage instructions.
65
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
Typestring
AdditionalInstructionLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents additional dosage instructions.
Typestring
AdditionalInstructionSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines additional dosage instructions.
Typeboolean
AsNeeded__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether a medication is taken only when needed within the specified schedule (true) orat every scheduled dose (false). The default checkbox value is deselected.
Typestring
AsNeededCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents whether a medication is taken only when neededwithin the specified schedule rather than at every scheduled dose.
Typestring
AsNeededLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents whether a medication is taken only when neededwithin the specified schedule rather than at every scheduled dose.
Typestring
AsNeededSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
66
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines whether a medication is taken only when needed within the specifiedschedule rather than at every scheduled dose.
Typestring
DoseQuantityUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the amount of medication that was dispensed.
Typestring
DoseQuantityValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe amount of medication that was dispensed.
Typereference
EhrPatient__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual receiving healthcare services.
Typetextarea
Instruction__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of how a medication is to be used by a patient.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
67
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MaxDosePerPeriodAmountUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the maximum total quantity of a therapeutic substance thatcan be administered to a subject over a period of time.
Typestring
MaxDosePerPeriodAmountValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
68
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe maximum total quantity of a therapeutic substance that can be administered to a subjectover a period of time.
Typestring
MaxDosePerPeriodDenominatorUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the denominator of the maximum total quantity of a therapeuticsubstance that can be administered to a subject over a period of time.
Typestring
MaxDosePerPeriodDenominatorValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe denominator in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.
Typestring
MaxDosePerPeriodNumeratorUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the numerator of the maximum total quantity of a therapeuticsubstance that can be administered to a subject over a period of time.
Typestring
MaxDosePerPeriodNumeratorValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe numerator in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.
Typestring
MaxDosePerPeriodTimeUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
69
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe unit of measurement of time in the maximum total quantity of a therapeutic substancethat can be administered to a subject over a period of time.
Typestring
MaxDosePerPeriodTimeValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe time value in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.
Typereference
MedicationPrescription__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn order for supply of a medication and the instructions for administration of the medicineto a patient. Lookup to EhrMedicationPrescription__c.
Typereference
MedicationStatement__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA record of the medication that the patient takes or that was given to the patient, where therecord is the result of a report from the patient or another clinician. Lookup toEhrMedicationStatement__c.
Typestring
MethodCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the method by which a medication is introducedinto or onto the body, most commonly used for injections.
Typestring
MethodLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
70
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe human-readable label that represents the method by which a medication is introducedinto or onto the body, most commonly used for injections.
Typestring
MethodSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the method by which a medication is introduced into or onto thebody, most commonly used for injections.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR dosage instruction ID. Limit: 255 characters.
Typestring
RateDenominator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe denominator in the speed at which the substance is introduced into the subject, typicallythe rate for an infusion. An example rate is 200ml in 2 hours.
Typestring
RateNumerator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe numerator in the speed at which the substance is introduced into the subject, typicallythe rate for an infusion. An example rate is 200ml in 2 hours.
Typestring
RouteCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.
71
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
Typestring
RouteLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.
Typestring
RouteSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the route or physiological path of administration of a therapeuticagent into or onto a subject.
Typestring
SiteCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that specifies the anatomic site where the medication first entersthe body.
Typestring
SiteLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that specifies the anatomic site where the medication first entersthe body.
Typestring
SiteSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the anatomic site where the medication first enters the body.
Typestring
SourceSystem__c
72
EhrDosageInstruction__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typetextarea
SupplementalInstructions__c
PropertiesCreate, Nillable, Update
DescriptionAny additional instructions.
TypedateTime
TimingPeriod__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe defined period of time.
TypedateTime
TimingPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last day of the time period.
TypedateTime
TimingPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first day of the time period.
73
EhrDosageInstruction__cElectronic Health Record Custom Objects
EhrEncounter__c
Represents an interaction between a patient and one or more healthcare providers for the purpose of providing the patient with healthcareservices or assessing a patient’s health status.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe individual account that represents the patient in Force.com.
Typestring
Class__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe classification of the encounter. Examples include inpatient, outpatient, ambulatory, andemergency.
Typereference
Encounter__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the interaction during which services are provided to the patient. Lookup toEhrEncounter__c.
Typestring
HospitalizeAdmitSourceCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the source from which the patient was admitted.Examples of sources include physician referral and transfer.
74
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
Typestring
HospitalAdmitSourceLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the source from which the patient was admitted.Examples of sources include physician referral and transfer.
Typestring
HospitalizeAdmitSourceSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the source from which the patient was admitted. Examples of sourcesinclude physician referral and transfer.
Typestring
HospitalizeDestination__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location to which the patient is discharged.
Typestring
HospitalizeDietCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents diet preferences that the patient reports.
Typestring
HospitalizeDietLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents diet preferences that the patient reports. Dietpreferences include medical, cultural, and ethical food preferences to help with cateringrequirements.
Typestring
HospitalizeDietSystem__c
75
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines diet preferences that the patient reports. Diet preferences includemedical, cultural, and ethical food preferences to help with catering requirements.
Typetextarea
HospitalizeDischargeDiagnosis__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of the final diagnosis that a patient receives before release from thehospital after all testing, surgery, and workup are completed.
Typestring
HospitalizeDischargeDispositionCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the category or kind of patient location afterdischarge.
Typestring
HospitalizeDischargeDispositionLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the category or kind of patient location afterdischarge.
Typestring
HospitalizeDischargeDispositionSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the category or kind of patient location after discharge.
Typetextarea
HospitalizeOrigin__c
PropertiesCreate, Nillable, Update
76
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe location from which the patient came before admission.
TypedateTime
HospitalizePeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last day when the specified participant was present during the encounter. Periods canoverlap or be subsets of the overall encounters period.
TypedateTime
HospitalizePeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first day when the specified participant was present during the encounter. Periods canoverlap or be subsets of the overall encounters period.
Typestring
HospitalizePreAdmissionId__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn identifier for hospitalization pre-admission.
Typeboolean
HospitalizeReadmission__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionWhether this hospitalization is a readmission (true) or not (false). The default checkboxvalue is deselected.
Typestring
HospitalizeSpecialArrangementCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents special arrangements such as a wheelchair,translator, or stretcher.
77
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
Typestring
HospitalizeSpecialArrangementLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents special arrangements such as a wheelchair,translator, or stretcher.
Typestring
HospitalizeSpecialArrangementSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines special arrangements such as a wheelchair, translator, or stretcher.
Typestring
HospitalizeSpecialCourtesyCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.
Typestring
HospitalizeSpecialCourtesyLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.
Typestring
HospitalizeSpecialCourtesySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a special courtesy such as a courtesy that’s extended to a boardmember or VIP.
Typetextarea
HospitalizationOrigin__c
78
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionThe location from which the patient came before admission.
Typestring
HospitalizationPreAdmissionId__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn identifier for hospitalization pre-admission.
Typestring
Indication__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe reason that the encounter occurs, as specified by using information from another resource.For admissions, this is the admission diagnosis. Typically the indication is a condition or aprocedure.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
79
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
LengthUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA unit of measurement of time that the encounter lasted, excluding the time during leavesof absence.
Typestring
LengthValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe length of time that the encounter lasted, excluding the time during leaves of absence.
Typestring
Location1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where a patient encounter occurs.
Typestring
Location1Country__c
80
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country where a patient encounter occurs.
Typestring
Location1Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the location where a patient encounter occurs.
TypedateTime
Location1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when this location is valid as a patient encounter location.
Typestring
Location1Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the location where a patient encounter occurs.
Typestring
Location1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the location where a patient encounter occurs.
Typestring
Location1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the location where a patient encounter occurs.
Typestring
Location1Name__c
81
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where a patient encounter occurs.
Typestring
Location1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the location where a patient encounter occurs.
TypedateTime
Location1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the location is valid as the location where a patient encounter occurs.
Typestring
Location1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the location where a patient encounter occurs.
TypedateTime
Location1TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
TypedateTime
Location1TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
82
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location1TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location1TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.
Typestring
Location1TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typetextarea
Location1Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where a patient encounter occurs.
Typestring
Location1TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
83
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.
Typestring
Location1TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.
Typestring
Location1TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of location where the patient encounter occurs.
Typestring
Location1Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the patient encounter occurs.
Typestring
Location1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where a patient encounter occurs.
Typestring
Location2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where a patient encounter occurs.
Typestring
Location2Country__c
84
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country where a patient encounter occurs.
Typestring
Location2Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the location where a patient encounter occurs.
TypedateTime
Location2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when this location is valid as a patient encounter location.
Typestring
Location2Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the location where a patient encounter occurs.
Typestring
Location2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the location where a patient encounter occurs.
Typestring
Location2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the location where a patient encounter occurs.
Typestring
Location2Name__c
85
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where a patient encounter occurs.
Typestring
Location2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the location where a patient encounter occurs.
TypedateTime
Location2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the location is valid as the location where a patient encounter occurs.
Typestring
Location2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the location where a patient encounter occurs.
TypedateTime
Location2TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
TypedateTime
Location2TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
86
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location2TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location2TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.
Typestring
Location2TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typetextarea
Location2Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where a patient encounter occurs.
Typestring
Location2TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
87
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.
Typestring
Location2TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.
Typestring
Location2TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of location where the patient encounter occurs.
Typestring
Location2Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the patient encounter occurs.
Typestring
Location2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where a patient encounter occurs.
Typestring
Location3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where a patient encounter occurs.
Typestring
Location3Country__c
88
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country where a patient encounter occurs.
Typestring
Location3Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the location where a patient encounter occurs.
TypedateTime
Location3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when this location is valid as a patient encounter location.
Typestring
Location3Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the location where a patient encounter occurs.
Typestring
Location3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the location where a patient encounter occurs.
Typestring
Location3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the location where a patient encounter occurs.
Typestring
Location3Name__c
89
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where a patient encounter occurs.
Typestring
Location3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the location where a patient encounter occurs.
TypedateTime
Location3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the location is valid as the location where a patient encounter occurs.
Typestring
Location3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the location where a patient encounter occurs.
TypedateTime
Location3TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
TypedateTime
Location3TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
90
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location3TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location3TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.
Typestring
Location3TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typetextarea
Location3Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where a patient encounter occurs.
Typestring
Location3TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
91
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.
Typestring
Location3TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.
Typestring
Location3TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of location where the patient encounter occurs.
Typestring
Location3Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the patient encounter occurs.
Typestring
Location3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where a patient encounter occurs.
Typestring
Location4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where a patient encounter occurs.
Typestring
Location4Country__c
92
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country where a patient encounter occurs.
Typestring
Location4Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the location where a patient encounter occurs.
TypedateTime
Location4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when this location is valid as a patient encounter location.
Typestring
Location4Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the location where a patient encounter occurs.
Typestring
Location4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the location where a patient encounter occurs.
Typestring
Location4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the location where a patient encounter occurs.
Typestring
Location4Name__c
93
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where a patient encounter occurs.
Typestring
Location4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the location where a patient encounter occurs.
TypedateTime
Location4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the location is valid as the location where a patient encounter occurs.
Typestring
Location4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the location where a patient encounter occurs.
TypedateTime
Location4TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
TypedateTime
Location4TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
94
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location4TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location4TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.
Typestring
Location4TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typetextarea
Location4Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where a patient encounter occurs.
Typestring
Location4TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
95
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.
Typestring
Location4TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.
Typestring
Location4TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of location where the patient encounter occurs.
Typestring
Location4Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the patient encounter occurs.
Typestring
Location4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where a patient encounter occurs.
Typestring
Location5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where a patient encounter occurs.
Typestring
Location5Country__c
96
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country where a patient encounter occurs.
Typestring
Location5Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the location where a patient encounter occurs.
TypedateTime
Location5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when this location is valid as a patient encounter location.
Typestring
Location5Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the location where a patient encounter occurs.
Typestring
Location5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of the location where a patient encounter occurs.
Typestring
Location5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of the location where a patient encounter occurs.
Typestring
Location5Name__c
97
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where a patient encounter occurs.
Typestring
Location5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of the location where a patient encounter occurs.
TypedateTime
Location5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the location is valid as the location where a patient encounter occurs.
Typestring
Location5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of the location where a patient encounter occurs.
TypedateTime
Location5TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
TypedateTime
Location5TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
98
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location5TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typestring
Location5TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.
Typestring
Location5TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.
Typetextarea
Location5Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where a patient encounter occurs.
Typestring
Location5TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
99
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.
Typestring
Location5TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.
Typestring
Location5TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of location where the patient encounter occurs.
Typestring
Location5Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of location where the patient encounter occurs.
Typestring
Location5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where a patient encounter occurs.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR encounter ID. Limit: 255 characters.
Typereference
Patient__c
100
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe patient’s name. Lookup to EhrPatient__c.
TypedateTime
PeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date and time when the period is valid for this patient encounter.
TypedateTime
PeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date and time when the period is valid for this patient encounter.
Typestring
PriorityCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the urgency of the patient encounter.
Typestring
PriorityLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the urgency of the patient encounter.
Typestring
PrioritySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the urgency of the patient encounter.
Typestring
Priority__c
101
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn indication of the urgency of the patient encounter. Examples include immediate,emergency, urgent, semi-urgent, and non-urgent.
Typestring
ReasonCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the reason why the patient encounter occurs. Foradmissions, the reason can be used for a coded admission diagnosis.
Typestring
ReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the reason why the patient encounter occurs. Foradmissions, the reason can be used for a coded admission diagnosis.
Typestring
ReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the reason why the patient encounter occurs. For admissions, thereason can be used for a coded admission diagnosis.
Typestring
Status__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn indication of the status of the patient encounter. Examples include planned, arrived,in-progress, onleave, finished, and cancelled.
Typestring
TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
102
EhrEncounter__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the specific type of patient encounter. Examplesof types include e-mail consultation, surgical day-care, skilled nursing, and rehabilitation.
Typestring
TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the specific type of patient encounter. Examplesof types include e-mail consultation, surgical day-care, skilled nursing, and rehabilitation.
Typestring
TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the specific type of patient encounter. Examples of types includee-mail consultation, surgical day-care, skilled nursing, and rehabilitation.
UsageA patient encounter is characterized by the setting in which it occurs. For example, the encounter can be ambulatory, emergency, homehealth, inpatient, or virtual. An encounter encompasses the lifecycle from pre-admission to discharge (for inpatient encounters). Duringthe encounter the patient can move from practitioner to practitioner and location to location.
EhrEncounterAccommodation__c
Represents the type of accommodation received by the patient during an encounter.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Bed__c
103
EhrEncounterAccommodation__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn indicator for the type of bed that the patient uses during the encounter.
Typereference
Encounter__c
PropertiesCreate, Filter, Group, Sort
DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
104
EhrEncounterAccommodation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR encounter accommodation ID. Limit: 255 characters.
Typestring
Period__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe time period when the accommodation type is valid.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
105
EhrEncounterAccommodation__cElectronic Health Record Custom Objects
EhrEncounterParticipant__c
Represents a person, other than the patient, who’s involved in the patient encounter.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Encounter__c
PropertiesCreate, Filter, Group, Sort
DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status.
Typedate
EndDate__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe last date when the specified participant was present during the patient encounter.Periods can overlap or be subsets of the overall encounters period.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
106
EhrEncounterParticipant__cElectronic Health Record Custom Objects
DetailsField
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR encounter participant ID. Limit: 255 characters.
Typereference
Practitioner__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionA person who’s involved in the providing of healthcare services. Lookup to EhrPractitioner__c.
Typereference
RelatedPerson__c
PropertiesCreate, Filter, Group, Sort, Update
107
EhrEncounterParticipant__cElectronic Health Record Custom Objects
DetailsField
DescriptionA person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’thave a formal responsibility in the process. Lookup to EhrRelatedPerson__c.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typedate
StartDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe last date when the specified participant was present during the patient encounter.Periods can overlap or be subsets of the overall encounters period.
Typestring
TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the role of the participant in the patient encounter.The type indicates how an individual participates in a patient encounter. It includesnonpractitioner participants and differs from practitioner roles. Examples include admittingdoctor, attending doctor, translator, and consulting doctor.
108
EhrEncounterParticipant__cElectronic Health Record Custom Objects
DetailsField
Typestring
TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the role of the participant in the patient encounter.The type indicates how an individual participates in a patient encounter. It includesnonpractitioner participants and differs from practitioner roles. Examples include admittingdoctor, attending doctor, translator, and consulting doctor.
Typestring
TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the role of the participant in the patient encounter. The type indicateshow an individual participates in a patient encounter. It includes nonpractitioner participantsand differs from practitioner roles. Examples include admitting doctor, attending doctor,translator, and consulting doctor.
EhrImmunization__c
Represents information about the administration of vaccines to patients.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com
109
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
DateAdministered__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when a vaccine was administered or was to be administered.
Typestring
DoseQuantity__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe quantity of vaccine product that was administered.
Typestring
DoseQuantityUnits__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the quantity of vaccine product that was administered.
Typestring
DoseQuantityValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe quantity of vaccine product that was administered.
TypedateTime
ExpirationDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when a vaccine batch expires.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
110
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
LocationCity__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city where the vaccine was administered.
Typestring
LocationCountry__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
111
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe country where the vaccine was administered.
Typestring
LocationId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for the service delivery location where the vaccine was administered.
Typestring
LocationLline1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of the address where the vaccine was administered.
Typestring
LocationLline2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of the address where the vaccine was administered.
Typestring
LocationName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the location where the vaccine was administered.
Typestring
LocationPostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address where the vaccine was administered.
TypedateTime
LocationStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
112
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when the vaccination location is valid.
Typestring
LocationState__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state where the vaccine was administered.
Typestring
LocationTelecom__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA contact detail for the location where the vaccine was administered.
Typetextarea
LocationText__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of the location where the vaccine was administered.
Typestring
LocationType__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA type of location where the vaccine was administered.
Typestring
LocationUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to the location where the vaccine was administered.
Typestring
LotNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
113
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe lot number of the vaccine product that was administered.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookupSort
DescriptionThe name of the vaccine product that was administered. Limit: 255 characters.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient who received or was to receive the vaccine. Lookup to EhrPatient__c.
Typereference
Performer__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe clinician who administered the vaccine. Lookup to EhrPractitioner__c.
Typestring
PerformerName255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe clinician who administered the vaccine. Limit: 255 characters.
Typetextarea
PerformerName__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the name of the clinician who administered the vaccine.
Typestring
ReasonCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
114
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the reason why a vaccination was administered.
Typestring
ReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the reason why a vaccination was administered.
Typestring
ReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the reason why a vaccination was administered.
Typestring
RefusalLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that indicates that the vaccine wasn’t administered.
Typestring
RefusalReasonCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the reason why a vaccine wasn’t administrated.
Typestring
RefusalReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the reason why a vaccine wasn’t administrated.
Typestring
RefusalReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
115
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines the reason why a vaccine wasn’t administrated.
Typeboolean
RefusedIndicator__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the vaccine was refused (true) or not (false). The default checkbox value isdeselected.
Typereference
Requestor__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe clinician who ordered the vaccine. Lookup to EhrPractitioner__c.
Typestring
RequestorName255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe clinician who ordered the vaccine. Limit: 255 characters.
Typetextarea
RequestorName__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the name of the clinician who ordered the vaccine.
Typestring
RouteCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the path through which the vaccine is taken intothe body.
Typestring
RouteLabel__c
116
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the path through which the vaccine is taken intothe body.
Typestring
RouteSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the path through which the vaccine is taken into the body.
Typeboolean
SelfReported__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the vaccine is self-reported (true) or not (false). The default checkbox valueis deselected.
Typestring
SiteCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the body site where the vaccine was administered.
Typestring
SiteLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the body site where the vaccine was administered.
Typestring
SiteSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the body site where the vaccine was administered.
117
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, NillableSort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
VaccineTypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the type of vaccine that was administered or wasto be administered.
Typestring
VaccineTypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of vaccine that was administered or wasto be administered.
Typestring
VaccineTypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
118
EhrImmunization__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines the type of vaccine that was administered or was to be administered.
UsageThis resource excludes the administration of nonvaccine agents, even those that have or claim to have immunological effects.
EhrImmunizationReaction__c
Represents categorical data indicating that an adverse event is associated in time with an immunization.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
Typetextarea
Details__c
PropertiesCreate, Nillable, Update
DescriptionAdditional information about the reaction.
Typereference
EhrObservation__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionMeasurements and assertions made regarding a patient or device. Lookup toEhrObservation__c.
119
EhrImmunizationReaction__cElectronic Health Record Custom Objects
DetailsField
Typereference
Immunization__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionInformation about the administration of vaccines to patients. Lookup to EhrImmunization__c.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
120
EhrImmunizationReaction__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR immunization reaction ID. Limit: 255 characters.
Typestring
Reaction255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails about a reaction that follows an immunization. Limit: 255 characters.
Typetextarea
Reaction__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of a reaction that follows an immunization.
TypedateTime
ReactionStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when the reaction to the immunization first occurred.
Typeboolean
SelfReported__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the reaction was self-reported (true) or not (false). The default checkbox valueis deselected.
Typestring
SourceSystem__c
121
EhrImmunizationReaction__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrMedicationPrescription__c
Represents an order for supply of a medication and the instructions for administration of the medicine to a patient.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
122
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
DateWritten__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date (and optionally time) when the prescription was written.
Typedouble
DispenseExpectedSupplyDuration__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe period of time over which the supplied product is expected to be used, or the length oftime the dispense is expected to last.
Note: In some situations, this attribute can be used instead of quantity to identifythe amount supplied by how long it’s expected to last rather than by the physicalquantity issued, for example, a 90-day supply of medication (based on an ordereddosage). This attribute is an estimate that can be influenced by external factors, sospecifying quantity is more precise.
Typestring
DispenseMedicationCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that identifies the medication being administered.
Typestring
DispenseMedicationCodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the code that identifies this medication.
TypedateTime
DispenseMedicationExpiration__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when a specific batch of product expires.
123
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
DispenseMedicationIsBrand__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.
Note: The manufacture doesn’t have to be known.
Typestring
DispenseMedicationKindCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
Typestring
DispenseMedicationKindLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
Typestring
DispenseMedicationKindSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.
Typestring
DispenseMedicationLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that identifies and defines a medication.
124
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typestring
DispenseMedicationLotNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe assigned lot number of a batch of the specified product.
Typestring
DispenseMedicationName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA common commercial name for the medication.
Typestring
DispenseMedicationProductFormCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the form of the product: powder, tablet, or carton+ code.
Typestring
DispenseMedicationProductFormLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the form of the product: powder, tablet, or carton+ human-readable label.
Typestring
DispenseMedicationProductFormSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the form of the product: powder, tablet, or carton + system.
Typedouble
DispenseNumberOfRepeatedAllowed__c
PropertiesCreate, Filter, Nillable, Sort, Update
125
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe number of allowed repeats of the medication dispense. For example, the number oftimes the prescribed quantity is to be supplied, including the initial standard fill.
Typestring
DispenseQuantityUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA unit of measurement in the amount to be dispensed for one fill.
Typedouble
DispenseQuantityValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe amount of medication to supply per dispense.
TypedateTime
DispenseValidityPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when the prescription is considered valid (not stale) by the prescriber. Dispensesmust not be made against the prescription after this date.
TypedateTime
DispenseValidityPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe earliest date when the prescription can be filled for the first time. If not specified, theprescription is open-ended or defaults to a stale date based on regulations.
Typereference
Encounter__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status. Lookupto EhrEncounter__c.
126
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MedicationCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
127
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that identifies a medication.
Typestring
MedicationCodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that identifies a medication.
Typestring
MedicationCodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a medication.
TypedateTime
MedicationExpiration__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when a specific batch of product expires.
Typeboolean
MedicationIsBrand__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.
Note: The manufacturer doesn’t have to be known.
Typestring
MedicationKindCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
128
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typestring
MedicationKindLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
Typestring
MedicationKindSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.
Typestring
MedicationLotNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe assigned lot number of a batch of the specified product.
Typestring
MedicationName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA common commercial name for the medication.
Typestring
MedicationProductFormCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.
Typestring
MedicationProductFormLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
129
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.
Typestring
MedicationProductFormSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR medication prescription ID. Limit: 255 characters.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe person to whom a medication will be given. Lookup to EhrPatient__c.
Typereference
Prescriber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe healthcare professional who’s responsible for authorizing the prescription. Lookup toEhrPractitioner__c.
Typestring
PrescriberName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe long text description of the name of the healthcare professional who’s responsible forauthorizing the prescription.
130
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typestring
ReasonCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the reason or indication for writing the prescription.
Typereference
ReasonCondition__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to EhrCondition__c.
Typestring
ReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the reason or indication for writing the prescription.
Typestring
ReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the reason or indication for writing the prescription.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
131
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
StatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe code that specifies the state of the order, typically active or completed.
Typestring
StatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that specifies the state of the order, typically active or completed.
Typestring
StatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the state of the order, typically active or completed.
Typetextarea
SubstituteRestrictReasonCode__c
PropertiesCreate, Nillable, Update
DescriptionThe system-defined code that indicates the reason why a substitution can’t be performed.
Typestring
SubstituteRestrictReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that indicates the reason why a substitution can’t be performed.
132
EhrMedicationPrescription__cElectronic Health Record Custom Objects
DetailsField
Typestring
SubstituteRestrictReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the reason why a substitution can’t be performed.
Typestring
SubstituteRestrictTypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that indicates whether a different drug can be dispensed fromwhat was prescribed.
Typestring
SubstituteRestrictTypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that indicates whether a different drug can be dispensed fromwhat was prescribed.
Typestring
SubstituteRestrictTypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines whether a different drug can be dispensed from what was prescribed.
EhrMedicationStatement__c
Represents a record of the medication that the patient takes or that was given to the patient,where the record is the result of a reportfrom the patient or another clinician.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
133
EhrMedicationStatement__cElectronic Health Record Custom Objects
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe individual account that represents the patient in Force.com
Typereference
Device__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA manufactured item that’s used in the providing of healthcare without being substantiallychanged through that activity. Lookup to EhrDevice__c.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
134
EhrMedicationStatement__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MedicationCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that identifies a medication.
Typestring
MedicationCodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that identifies a medication.
Typestring
MedicationCodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a medication.
TypedateTime
MedicationExpiration__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when a specific batch of product expires.
135
EhrMedicationStatement__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
MedicationIsBrand__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.
Note: The manufacturer doesn’t have to be known.
Typestring
MedicationKindCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
Typestring
MedicationKindLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.
Typestring
MedicationKindSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.
Typestring
MedicationLotNumber__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe assigned lot number of a batch of the specified product.
136
EhrMedicationStatement__cElectronic Health Record Custom Objects
DetailsField
Typestring
MedicationName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA common commercial name for the medication.
Typestring
MedicationProductFormCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.
Typestring
MedicationProductFormLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.
Typestring
MedicationProductFormSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR medication statement ID. Limit: 255 characters.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
137
EhrMedicationStatement__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe person who’s taking the medication. Lookup to EhrPatient__c.
Typestring
ReasonNotGivenCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that indicates why the medication wasn’t taken.
Typestring
ReasonNotGivenLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that indicates why the medication wasn’t taken.
Typestring
ReasonNotGivenSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that indicates why the medication wasn’t taken.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
138
EhrMedicationStatement__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typeboolean
WasNotGiven__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionWhether the medication wasn’t taken (true) or was taken (false). The default checkboxvalue is deselected.
TypedateTime
WhenGiven__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe date when the medication was taken.
EhrObservation__c
Represents measurements and assertions made regarding a patient or device. Observations are a central element in healthcare, usedto support diagnosis, monitor progress, determine baselines and patterns, and even capture demographic characteristics.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
TypedateTime
AppliesDateTime__c
139
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe time or time period when the observed value is asserted as being true, usually the timeof a procedure or specimen collection. Often the source of the date or time isn’t known.Unless this observation is a historical report, a date is required.
TypedateTime
AppliesPeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last day when the observed value is asserted as being true.
TypedateTime
AppliesPeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first day when the observed value is asserted as being true.
Typestring
BodySiteCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the site on the patient’s body where the observationwas made (also called the target site).
Typestring
BodySiteLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the site on the patient’s body where the observationwas made (also called the target site).
Typestring
BodySiteSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
140
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines the site on the patient’s body where the observation was made (alsocalled the target site).
Typetextarea
Comments__c
PropertiesCreate, Nillable, Update
DescriptionStatements about significant, unexpected, or unreliable values—or information about thesource of the observed value—that can be relevant to the interpretation of the result.
Typereference
Device__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe device that’s used to generate the observation data. Lookup to EhrDevice__c.
Typestring
InterpretationCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the assessment that’s made based on theobservation results. For some results, especially numeric results, an interpretation is necessaryto fully understand the significance of a result.
Typestring
InterpretationLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the assessment that’s made based on the resultof the observation. For some results, especially numeric results, an interpretation is necessaryto fully understand the significance of a result.
Typestring
InterpretationSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
141
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines the assessment that’s made based on the result of the observation.For some results, especially numeric results, an interpretation is necessary to fully understandthe significance of a result.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
TypedateTime
IssuedDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date and time when the observation was made available. Updated when the result isupdated.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
142
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MethodCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the mechanism that’s used to perform theobservation. In some cases, method can impact results and is therefore used to determinewhether results can be compared or to determine the significance of results.
Typestring
MethodLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the mechanism that’s used to perform theobservation. In some cases, method can impact results and is therefore used to determinewhether results can be compared or to determine the significance of results.
Typestring
MethodSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the mechanism that’s used to perform the observation. In somecases, method can impact results and is therefore used to determine whether results can becompared or to determine the significance of results.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR observation ID. Limit: 255 characters.
143
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
Typestring
NameCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the name of the observation.
Typestring
NameLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the name of the observation.
Typestring
NameSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the name of the observation.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient’s name. Lookup to Ehr_Patient__c.
Typereference
Practitioner__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA person with a formal responsibility in the providing of healthcare services. Lookup toEhrPractitioner__c.
Typestring
ReferenceMeaningLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
144
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe human-readable label that represents the meaning of the applicable reference range,which provides guidance on how to interpret the observed value by comparison to a normalor recommended range. Specify what kind of reference range it is (for example, normal,recommended, or therapeutic), or what state this reference range applies to (for example,age or hormonal cycles).
Typestring
ReferenceRangeAgeHigh__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe age at the high end of the applicable reference range. Can be a neonatal age (for example,number of weeks at term). If this element is omitted, the high value of the reference rangeis assumed to be meaningless (for example, the reference range is > 5). If the low comparatoris missing , it’s assumed to be “<”.
Typestring
ReferenceRangeAgeLow__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe age at the low end of the applicable reference range. Can be a neonatal age (for example,number of weeks at term). If this element is omitted, the low value of the reference range isassumed to be meaningless (for example, the reference range is < 2). If the high comparatoris missing, it’s assumed to be “>”.
Typestring
ReferenceRangeHighUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the applicable reference range.
Typestring
ReferenceRangeHighValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe value at the high end of the applicable reference range. If this element is omitted, thehigh value of the reference range is assumed to be meaningless. (for example, the referencerange is > 5). If the low comparator is missing, it’s assumed to be “<”.
145
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
Typestring
ReferenceRangeLowUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe unit of measurement in the applicable reference range.
Typestring
ReferenceRangeLowValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe value at the low end of the applicable reference range. If this element is omitted, thelow value of the reference range is assumed to be meaningless. (for example, the referencerange is < 2). If the high comparator is missing, it’s assumed to be “>”.
Typestring
ReferenceRangeMeaningCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the meaning of the applicable reference range.Specify what kind of reference range it is (for example, normal, recommended, or therapeutic),or what state this reference range applies to (for example, age or hormonal cycles).
Typestring
ReferenceRangeMeaningSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the meaning of the applicable reference range.
Typestring
ReferenceRangeUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA unit of measurement within the applicable reference range.
Typepicklist
Reliability__c
146
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn estimate of the degree to which quality issues have impacted the reported value. Picklistvalues: calibrating, early, error, ok, ongoing, and questionable.
Typestring
ReliabilityCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the estimate of the degree to which quality issueshave impacted the reported value.
Typestring
SampledData__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionData that comes from a series of measurements that were taken by a device, with upper andlower limits. Can include multiple dimensions.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
147
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
Typepicklist
Status__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe status of the observation’s result value. Picklist values: amended, final, preliminary, andregistered.
Typestring
StatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the status of the observation’s result value.
Typestring
ValueAttachment__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn attachment related to the observed value. Attachments include additional data contentdefined in other formats such as PDF, typically images or reports.
Typestring
ValueCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the information determined by making theobservation, if the information has a simple value.
Typestring
ValueLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the information determined by making theobservation, if the information has a simple value.
Typestring
ValuePeriod__c
148
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe period during which the observed value is valid.
TypedateTime
ValuePeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when the observed value is valid.
TypedateTime
ValuePeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the observed value is valid.
Typestring
ValueQuantity__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA measured or potentially measurable amount related to the observed value.
Typestring
ValueQuantityUnit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA unit of measurement related to the observed value.
Typestring
ValueRatio__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA relationship between two quantities, expressed as a numerator and a denominator, relatedto the observed value.
149
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
Typestring
ValueRatioDenominator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe denominator in the relationship between two quantities related to the observed value.
Typestring
ValueRatioNumerator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe numerator in the relationship between two quantities related to the observed value.
Typetextarea
ValueSampledData__c
PropertiesCreate, Nillable, Update
DescriptionData that comes from a series of measurements taken by a device, related to the observedvalue.
Typestring
ValueSampledDataDimensions__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe number of sample points at each time point in the sampled data. If this value is greaterthan one, all sample points for a point in time are recorded at the same time.
Typestring
ValueSampledDataFactor__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA correction factor that’s applied to the sampled data points before they’re added to theorigin.
Typestring
ValueSampledDataLowerLimit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
150
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe lower limit of detection of the measured points in the sampled data. Required if anydata points have the value L (lower than detection limit).
Typestring
ValueSampledDataOrigin__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe base quantity that a measured value of zero represents in the sampled data. This valueprovides the units of the entire measurement series.
Typestring
ValueSampledDataOriginCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the base quantity that a measured value of zerorepresents in the sampled data.
Typestring
ValueSampledDataOriginCodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the base quantity that a measured value of zerorepresents in the sampled data.
Typestring
ValueSampledDataOriginCodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.
Typestring
ValueSampledDataOriginComparator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
151
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionA comparator used with the base quantity that a measured value of zero represents in thesampled data.
Typestring
ValueSampledDataOriginSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.
Typestring
ValueSampledDataOriginUnits__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionUnits of measurement in the base quantity that a measured value of zero represents in thesampled data.
Typestring
ValueSampledDataOriginValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable value used in the base quantity that a measured value of zero representsin the sampled data.
Typestring
ValueSampledDataPeriodMili__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA time period defined by a start and end date and optionally time, related to the sampleddata.
Typestring
ValueSampledDataUpperLimit__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe upper limit in data that comes from a series of measurements taken by a device.
152
EhrObservation__cElectronic Health Record Custom Objects
DetailsField
Typestring
ValueSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the information determined by making the observation, if theinformation has a simple value.
UsageMost observations are simple name-value pair assertions with some metadata, but some observations group other observations togetherlogically, or even are multicomponent observations.
EhrPatient__c
Represents the demographics and other administrative information about a patient who’s receiving health-related services.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
Typestring
Address1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
153
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
154
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address1Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient.
Typestring
Address1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address2Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
155
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address2Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient.
156
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
157
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address3Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient.
Typestring
Address3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
158
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
159
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address4Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient.
Typestring
Address4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
160
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address5Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient.
161
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
TypedateTime
BirthDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe patient’s birth date.
Typestring
Communication1Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication1Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication2Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
162
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication2Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication3Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication3Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
163
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication4Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication4Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication5Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication5Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
164
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typeboolean
Deceased__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.
Typestring
FamilyName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).
Typestring
FamilyName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).
Typestring
FamilyName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).
165
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
GenderCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.
Typestring
GenderLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.
Typestring
GenderSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.
Typestring
GivenName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName3__c
166
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName5__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typeboolean
IntegrationIsActive__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether integration is active (true) or not (false). The default checkbox value is selected.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
167
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MaritalStatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the patient’s most recent civil marital status.
Typestring
MaritalStatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the patient’s most recent civil marital status.
Typestring
MaritalStatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
168
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines the patient’s most recent civil marital status.
Typestring
MedicalRecordNumber__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe medical record number used to identify a patient.
Typeboolean
MultipleBirth__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookupSort
DescriptionThe EHR patient ID. Limit: 255 characters.
Typetextarea
Name__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of a name associated with the patient.
Typestring
Organization255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization on behalf of which the patient contact is acting, for which the patientcontact is working, or that’s the custodian of the patient record. Limit: 255 characters.
Typetextarea
Organization__c
169
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization on behalf of which the patient contact is acting,for which the patient contact is working, or that’s the custodian of the patient record.
Typetextarea
PhotoUrl__c
PropertiesCreate, Nillable, Update
DescriptionThe URL for a photo of the patient.
Typestring
PrefixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first prefix in the patient’s name.
Typestring
PrefixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in the patient’s name.
Typestring
PrefixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in the patient’s name.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
170
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
SuffixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first suffix in the patient’s name.
Typestring
SuffixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second suffix in the patient’s name.
Typestring
SuffixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third suffix in the patient’s name.
TypedateTime
Telecom1PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
171
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom1PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to the patient’s contact information.
Typestring
Telecom1Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom2PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
172
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Telecom2PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to the patient’s contact information.
Typestring
Telecom2Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom3PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom3PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
173
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to the patient’s contact information.
Typestring
Telecom3Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom4PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom4PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
174
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
Typestring
Telecom4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to the patient’s contact information.
Typestring
Telecom4Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom5PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom5PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
175
EhrPatient__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to the patient’s contact information.
Typestring
Telecom5Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
UsageA patient record is typically created and maintained by each organization providing care for a patient. A patient receiving care at multipleorganizations can have information present in multiple patient resources.
EhrPatientCareProvider
Represents the patient’s nominated care provider.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
176
EhrPatientCareProviderElectronic Health Record Custom Objects
DetailsField
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR patient care provider ID. Limit: 255 characters.
177
EhrPatientCareProviderElectronic Health Record Custom Objects
DetailsField
Typestring
Organization255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization on behalf of which the patient contact is acting, for which the patientcontact is working, or that’s the custodian of the patient record. Limit: 255 characters.
Typetextarea
Organization__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization on behalf of which the patient contact is acting,for which the patient contact is working, or that’s the custodian of the patient record.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe patient’s name.
Typereference
Practitioner__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe practitioner’s name. Lookup to EhrPractitioner__c.
Typestring
PractitionerName255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe practitioner’s name. Limit: 255 characters.
Typestring
PractitionerName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
178
EhrPatientCareProviderElectronic Health Record Custom Objects
DetailsField
DescriptionThe long text description of the practitioner’s name.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
Typestring
SourceSystemModified__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrPatientContact__c
Represents a contact party (for example, a guardian, partner, or friend) for the patient.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Address1City__c
179
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient contact.
Typestring
Address1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient contact.
TypedateTime
Address1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient contact is valid.
Typestring
Address1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient contact.
Typestring
Address1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient contact.
Typestring
Address1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient contact.
TypedateTime
Address1StartDate__c
180
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient contact is valid.
Typestring
Address1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient contact.
Typetextarea
Address1Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient contact.
Typestring
Address1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient contact.
Typestring
Address2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient contact.
Typestring
Address2Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient contact.
TypedateTime
Address2EndDate__c
181
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient contact is valid.
Typestring
Address2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient contact.
Typestring
Address2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient contact.
Typestring
Address2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient contact.
TypedateTime
Address2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient contact is valid.
Typestring
Address2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient contact.
Typetextarea
Address2Text__c
182
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient contact.
Typestring
Address2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient contact.
Typestring
Address3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient contact.
Typestring
Address3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient contact.
TypedateTime
Address3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient contact is valid.
Typestring
Address3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient contact.
Typestring
Address3Line2__c
183
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient contact.
Typestring
Address3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient contact.
TypedateTime
Address3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient contact is valid.
Typestring
Address3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient contact.
Typetextarea
Address3Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient contact.
Typestring
Address3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient contact.
Typestring
Address4City__c
184
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient contact.
Typestring
Address4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient contact.
TypedateTime
Address4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient contact is valid.
Typestring
Address4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient contact.
Typestring
Address4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient contact.
Typestring
Address4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient contact.
TypedateTime
Address4StartDate__c
185
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient contact is valid.
Typestring
Address4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient contact.
Typetextarea
Address4Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient contact.
Typestring
Address4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient contact.
Typestring
Address5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient contact.
Typestring
Address5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient contact.
TypedateTime
Address5EndDate__c
186
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient contact is valid.
Typestring
Address5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient contact.
Typestring
Address5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient contact.
Typestring
Address5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient contact.
TypedateTime
Address5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient contact is valid.
Typestring
Address5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient contact.
Typetextarea
Address5Text__c
187
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient contact.
Typestring
Address5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient contact.
Typestring
FamilyName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient contact’s family name (Smith in Carol Smith Rodgers Andrews)
Typestring
FamilyName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient contact’s family name (Rodgers in Carol Smith RodgersAndrews)
Typestring
FamilyName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient contact’s family name (Andrews in Carol Smith RodgersAndrews)
Typestring
GenderCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.
188
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
Typestring
GenderLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.
Typestring
GenderSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the gender that the patient contact is considered to have foradministration and record-keeping purposes.
Typestring
GivenName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient contact’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)
Typestring
GivenName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)
Typestring
GivenName4__c
189
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fourth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)
Typestring
GivenName5__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fifth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
Description
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
190
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
• Due date of the most recently closed task associated with the record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR patient contact ID. Limit: 255 characters.
Typetextarea
Name__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the name of the patient contact.
Typestring
Organization255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization on behalf of which the contact is acting, for which the contact is working,or that’s the custodian of the patient record. Limit: 255 characters.
Typetextarea
Organization__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization on behalf of which the contact is acting, forwhich the contact is working, or that’s the custodian of the patient record.
Typereference
Patient__c
191
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Sort
DescriptionThe patient’s name.
TypedateTime
PeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last day when the contact or organization is valid and can be contacted regarding thepatient.
TypedateTime
PeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first day when the contact or organization is valid and can be contacted regarding thepatient.
Typestring
PrefixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first prefix in a patient contact name.
Typestring
PrefixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in a patient contact name.
Typestring
PrefixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in a patient contact name.
192
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
Typestring
RelationshipCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the nature of the relationship between the patientand the patient contact.
Typestring
RelationshipLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the nature of the relationship between the patientand the patient contact.
Typestring
RelationshipSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the nature of the relationship between the patient and the patientcontact.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, NillableSort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
193
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
SuffixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first suffix in a patient contact name.
Typestring
SuffixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second suffix in a patient contact name.
Typestring
SuffixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third suffix in a patient contact name.
TypedateTime
Telecom1PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
TypedateTime
Telecom1PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
Typestring
Telecom1System__c
194
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.
Typestring
Telecom1Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom2PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
TypedateTime
Telecom2PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
Typestring
Telecom2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
195
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.
Typestring
Telecom2Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom3PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
TypedateTime
Telecom3PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
Typestring
Telecom3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
196
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
Typestring
Telecom3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.
Typestring
Telecom3Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom4PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
TypedateTime
Telecom4PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
Typestring
Telecom4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom4Use__c
197
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.
Typestring
Telecom4Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom5PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
TypedateTime
Telecom5PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.
Typestring
Telecom5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.
Typestring
Telecom5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
198
EhrPatientContact__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.
Typestring
Telecom5Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
EhrPractitioner__c
Represents a person who’s involved in the providing of healthcare.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Address1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
199
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Address1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address1State__c
200
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typetextarea
Address1Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.
Typestring
Address2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address2Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
201
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
202
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typetextarea
Address2Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.
Typestring
Address3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
203
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
204
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typetextarea
Address3Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.
Typestring
Address4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
205
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
206
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typetextarea
Address4Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.
Typestring
Address5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
207
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.
Typestring
Address5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.
TypedateTime
Address5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.
Typestring
Address5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
208
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typetextarea
Address5Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.
Typestring
Address5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.
TypedateTime
BirthDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe practitioner’s birth date, needed for identification.
Typestring
Communication1Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication1Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
209
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Communication1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.
Typestring
Communication2Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication2Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.
Typestring
Communication3Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication3Label__c
210
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.
Typestring
Communication4Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication4Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.
Typestring
Communication5Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
211
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication5Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.
Typestring
Communication5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.
Typestring
FamilyName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the practitioner’s family name (Smith in Carol Smith Rodgers Andrews).
Typestring
FamilyName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the practitioner’s family name (Rodgers in Carol Smith Rodgers Andrews).
Typestring
FamilyName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the practitioner’s family name (Andrews in Carol Smith Rodgers Andrews).
212
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Gender__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe gender that the practitioner is considered to have for administration and record-keepingpurposes, needed to address the practitioner correctly.
Typestring
GivenName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fourth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName5__c
213
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fifth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typestring
Location1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city associated with a location where the practitioner provides care.
Typestring
Location1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country associated with a location where the practitioner provides care.
Typestring
Location1Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of a location where the practitioner provides care.
214
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Location1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a location is valid as a location where the practitioner provides care.
Typestring
Location1Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for a location where the practitioner provides care.
Typestring
Location1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of a location where the practitioner provides care.
Typestring
Location1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of a location where the practitioner provides care.
Typestring
Location1Name__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of a location where the practitioner provides care.
Typestring
Location1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of a location where the practitioner provides care.
215
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Location1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as a location where the practitioner provides care.
Typestring
Location1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of a location where the practitioner provides care.
TypedateTime
Location1TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.
TypedateTime
Location1TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.
Typestring
Location1TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.
Typestring
Location1TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
216
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.
Typestring
Location1TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.
Typetextarea
Location1Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of a location where the practitioner provides care.
Typestring
Location1Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location type for a location where the practitioner provides care.
Typestring
Location1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where the practitioner provides care.
Typestring
Location2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city associated with a location where the practitioner provides care.
Typestring
Location2Country__c
217
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country associated with a location where the practitioner provides care.
Typestring
Location2Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of a location where the practitioner provides care.
TypedateTime
Location2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a location is valid as a location where the practitioner provides care.
Typestring
Location2Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for a location where the practitioner provides care.
Typestring
Location2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of a location where the practitioner provides care.
Typestring
Location2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of a location where the practitioner provides care.
Typestring
Location2Name__c
218
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of a location where the practitioner provides care
Typestring
Location2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of a location where the practitioner provides care.
TypedateTime
Location2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as a location where the practitioner provides care.
Typestring
Location2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of a location where the practitioner provides care.
TypedateTime
Location2TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.
TypedateTime
Location2TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.
219
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location2TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.
Typestring
Location2TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.
Typestring
Location2TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.
Typetextarea
Location2Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of a location where the practitioner provides care.
Typestring
Location2Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location type for a location where the practitioner provides care.
Typestring
Location2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
220
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home or office related to a location where the practitioner provides care.
Typestring
Location3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city associated with a location where the practitioner provides care.
Typestring
Location3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country associated with a location where the practitioner provides care.
Typestring
Location3Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of a location where the practitioner provides care.
TypedateTime
Location3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a location is valid as a location where the practitioner provides care.
Typestring
Location3Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for a location where the practitioner provides care.
Typestring
Location3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
221
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe first line in the address of a location where the practitioner provides care.
Typestring
Location3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of a location where the practitioner provides care.
Typestring
Location3Name__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of a location where the practitioner provides care.
Typestring
Location3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of a location where the practitioner provides care.
TypedateTime
Location3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as a location where the practitioner provides care.
Typestring
Location3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of a location where the practitioner provides care.
TypedateTime
Location3TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
222
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.
TypedateTime
Location3TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.
Typestring
Location3TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.
Typestring
Location3TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.
Typestring
Location3TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.
Typetextarea
Location3Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of a location where the practitioner provides care.
223
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location3Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location type for a location where the practitioner provides care.
Typestring
Location3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office about a location where the practitioner provides care.
Typestring
Location4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city associated with a location where the practitioner provides care.
Typestring
Location4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country associated with a location where the practitioner provides care.
Typestring
Location4Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of a location where the practitioner provides care.
TypedateTime
Location4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a location is valid as a location where the practitioner provides care.
224
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location4Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for a location where the practitioner provides care.
Typestring
Location4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of a location where the practitioner provides care.
Typestring
Location4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of a location where the practitioner provides care.
Typestring
Location4Name__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of a location where the practitioner provides care.
Typestring
Location4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of a location where the practitioner provides care.
TypedateTime
Location4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as a location where the practitioner provides care.
225
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of a location where the practitioner provides care.
TypedateTime
Location4TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.
TypedateTime
Location4TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.
Typestring
Location4TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.
Typestring
Location4TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.
Typestring
Location4TelecomValue__c
226
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.
Typetextarea
Location4Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of a location where the practitioner provides care.
Typestring
Location4Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location type for a location where the practitioner provides care.
Typestring
Location4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where the practitioner provides care.
Typestring
Location5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city associated with a location where the practitioner provides care.
Typestring
Location5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country associated with a location where the practitioner provides care.
227
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location5Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of a location where the practitioner provides care.
TypedateTime
Location5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a location is valid as a location where the practitioner provides care.
Typestring
Location5Id__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external identifier for a location where the practitioner provides care.
Typestring
Location5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line in the address of a location where the practitioner provides care.
Typestring
Location5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line in the address of a location where the practitioner provides care.
Typestring
Location5Name__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of a location where the practitioner provides care.
228
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Location5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code in the address of a location where the practitioner provides care.
TypedateTime
Location5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a location is valid as a location where the practitioner provides care.
Typestring
Location5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in the address of a location where the practitioner provides care.
TypedateTime
Location5TelecomPeriodEnd__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.
TypedateTime
Location5TelecomPeriodStart__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.
Typestring
Location5TelecomSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
229
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.
Typestring
Location5TelecomUse__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.
Typestring
Location5TelecomValue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.
Typetextarea
Location5Text__c
PropertiesCreate, Nillable, Update
DescriptionThe complete address of a location where the practitioner provides care.
Typestring
Location5Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe location type for a location where the practitioner provides care.
Typestring
Location5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to a location where the practitioner provides care.
230
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR practitioner ID. Limit: 255 characters.
Typestring
Name255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the practitioner. Limit: 255 characters.
Typetextarea
Name__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the practitioner’s name.
Typestring
Organization255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization where the practitioner performs the associated roles. Limit: 255 characters.
Typetextarea
Organization__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization where the practitioner performs the associatedroles.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
Description
231
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
Typestring
Period__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe period during which the practitioner is authorized to act as a practitioner in these rolesfor the organization.
Typetextarea
PhotoUrl__c
PropertiesCreate, Nillable, Update
DescriptionThe URL for a photo of the practitioner.
Typestring
PrefixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first prefix in the practitioner’s name.
Typestring
PrefixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in the practitioner’s name.
Typestring
PrefixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in the practitioner’s name.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
232
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
SpecialtyCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a specialty of the practitioner’s.
Typestring
SpecialtySystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner’s.
Typestring
SuffixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first suffix in the practitioner’s name.
Typestring
SuffixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
233
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe second suffix in the practitioner’s name.
Typestring
SuffixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third suffix in the practitioner’s name.
TypedateTime
Telecom1PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for the practitioner.
TypedateTime
Telecom1PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for the practitioner.
Typestring
Telecom1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.
Typestring
Telecom1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.
Typestring
Telecom1Value__c
234
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.
TypedateTime
Telecom2PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for the practitioner.
TypedateTime
Telecom2PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for the practitioner.
Typestring
Telecom2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.
Typestring
Telecom2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.
Typestring
Telecom2Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.
235
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Telecom3PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for the practitioner.
TypedateTime
Telecom3PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for the practitioner.
Typestring
Telecom3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.
Typestring
Telecom3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.
Typestring
Telecom3Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.
TypedateTime
Telecom4PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
236
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe last date when a contact detail is valid for the practitioner.
TypedateTime
Telecom4PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for the practitioner.
Typestring
Telecom4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.
Typestring
Telecom4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.
Typestring
Telecom4Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.
TypedateTime
Telecom5PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail is valid for the practitioner.
TypedateTime
Telecom5PeriodStartDate__c
237
EhrPractitioner__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail is valid for the practitioner.
Typestring
Telecom5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.
Typestring
Telecom5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.
Typestring
Telecom5Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.
UsageThis resource covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formalresponsibilities. This resource is used for attribution of activities and responsibilities to these individuals.
EhrPractitionerIdentity__c
Represents external identities such as licenses and regional identifiers for a practitioner.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
238
EhrPractitionerIdentity__cElectronic Health Record Custom Objects
Fields
DetailsField
Typestring
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe description of the identifier.
Typereference
EhrPractitioner__c
PropertiesCreate, Filter, Group, Sort
DescriptionA person who’s involved in the providing of healthcare.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
Typestring
Name
239
EhrPractitionerIdentity__cElectronic Health Record Custom Objects
DetailsField
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR practitioner identity name. Limit: 255 characters.
Typestring
Organization__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization that the external identifier applies to. Limit: 255 characters.
Typedate
PeriodEndDate
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date when the identifier expires.
Typedate
PeriodStartDate
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first date when the identifier is active.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
240
EhrPractitionerIdentity__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the practitioner identity.
Typestring
TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the practitioner identity type: license, registration,or ID.
Typestring
TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the practitioner identity type: license, registration,or ID.
Typestring
TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the practitioner identity type.
Typestring
Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
Description
241
EhrPractitionerIdentity__cElectronic Health Record Custom Objects
DetailsField
Typestring
Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAn identifier for the external system.
EhrPractitionerQualification__c
Represents qualifications obtained by the practitioner through training and certification.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a practitioner qualification.
Typestring
CodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a practitioner qualification.
Typestring
CodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a practitioner qualification.
242
EhrPractitionerQualification__cElectronic Health Record Custom Objects
DetailsField
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typestring
Issuer255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization that regulates and issues the qualification. Limit: 255 characters.
Typestring
Issue__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe long text description of the organization that regulates and issues the qualification.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
243
EhrPractitionerQualification__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR practitioner qualification ID. Limit: 255 characters.
Typedate
PeriodEnd__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe last date when a qualification is valid.
Typedate
PeriodStart__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first date when a qualification is valid.
Typereference
Practitioner__c
PropertiesCreate, Filter, Group, Sort
DescriptionA person who’s involved in the providing of healthcare.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
244
EhrPractitionerQualification__cElectronic Health Record Custom Objects
DetailsField
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrPractitionerRole__c
Represents a list of roles that the practitioner can perform for a given time period.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
EhrPractitioner__c
PropertiesCreate, Filter, Group, Sort
DescriptionA person who’s involved in the providing of healthcare.
TypedateTime
EndDate__c
245
EhrPractitionerRole__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when the practitioner is authorized to act as a practitioner in these roles for theorganization.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR practitioner role ID. Limit: 255 characters.
Typestring
RoleCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
246
EhrPractitionerRole__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents the practitioner’s role.
Typestring
RoleLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the practitioner’s role.
Typestring
RoleSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the practitioner’s role.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Specialty1Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
247
EhrPractitionerRole__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents a specialty of the practitioner.
Typestring
Specialty1Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a specialty of the practitioner.
Typestring
Specialty1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner.
Typestring
Specialty2Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a specialty of the practitioner.
Typestring
Specialty2Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a specialty of the practitioner.
Typestring
Specialty2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner.
Typestring
Specialty3Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
248
EhrPractitionerRole__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents a specialty of the practitioner.
Typestring
Specialty3Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a specialty of the practitioner.
Typestring
Specialty3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner.
Typestring
Specialty4Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a specialty of the practitioner.
Typestring
Specialty4Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a specialty of the practitioner.
Typestring
Specialty4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner.
Typestring
Specialty5Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
249
EhrPractitionerRole__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents a specialty of the practitioner.
Typestring
Specialty5Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a specialty of the practitioner.
Typestring
Specialty5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a specialty of the practitioner.
TypedateTime
StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when the practitioner is authorized to act as a practitioner in these roles forthe organization.
EhrRelatedObservation__c
Represents another observation that’s a component of a parent observation or that provides supporting information, context, or warningsabout the primary observation. Examples are components, previous observations, and statements of derivation.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typeboolean
IsRestricted__c
250
EhrRelatedObservation__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR related observation name. Limit: 255 characters.
251
EhrRelatedObservation__cElectronic Health Record Custom Objects
DetailsField
Typereference
Observation__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe measurements and assertions made, regarding a patient or device, that this observationis related to.
Typereference
RelatedObservation__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe related observation. Lookup to EhrObservation__c.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typepicklist
Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
252
EhrRelatedObservation__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe type of relationship that exists with the target observation. Picklist values: derived-from,has-component, has-member, interfered-by, qualified-by, replaces, and sequel-to.
Typestring
TypeCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the type of relationship that exists with the targetobservation.
Typestring
TypeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the type of relationship that exists with the targetobservation.
Typestring
TypeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the type of relationship that exists with the target observation.
UsageSome observations have important relationships to other observations (for example, blood pressure = systolic + diastolic) or are derivedfrom other observations (for example, calculated apgar score). Typically an observation has either a value or a set of related observations.Some observations (for example apgar store) can have a value and related observations (for apgar, the observations from which themeasure is derived).
EhrRelatedPerson__c
Represents a person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’t have a formal responsibility in theprocess.
253
EhrRelatedPerson__cElectronic Health Record Custom Objects
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe individual account that represents the patient in Force.com.
Typestring
Address1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the related person.
Typestring
Address1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the related person.
TypedateTime
Address1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the related person is valid.
Typestring
Address1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the related person.
254
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the related person.
Typestring
Address1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the related person.
TypedateTime
Address1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the related person is valid.
Typestring
Address1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the related person.
Typetextarea
Address1Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the related person.
Typestring
Address1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the related person.
255
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the related person.
Typestring
Address2Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the related person.
TypedateTime
Address2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the related person is valid.
Typestring
Address2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the related person.
Typestring
Address2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the related person.
Typestring
Address2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the related person.
256
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Address2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the related person is valid.
Typestring
Address2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the related person.
Typetextarea
Address2Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the related person.
Typestring
Address2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the related person.
Typestring
Address3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the related person.
Typestring
Address3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the related person.
257
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Address3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the related person is valid.
Typestring
Address3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the related person.
Typestring
Address3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the related person.
Typestring
Address3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the related person.
TypedateTime
Address3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the related person is valid.
Typestring
Address3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the related person.
258
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typetextarea
Address3Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the related person.
Typestring
Address3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the related person.
Typestring
Address4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the related person.
Typestring
Address4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the related person.
TypedateTime
Address4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the related person is valid.
Typestring
Address4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the related person.
259
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the related person.
Typestring
Address4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the related person.
TypedateTime
Address4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the related person is valid.
Typestring
Address4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the related person.
Typetextarea
Address4Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the related person.
Typestring
Address4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the related person.
260
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typestring
Address5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the related person.
Typestring
Address5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the related person.
TypedateTime
Address5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the related person is valid.
Typestring
Address5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the related person.
Typestring
Address5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the related person.
Typestring
Address5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the related person.
261
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
Address5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the related person is valid.
Typestring
Address5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the related person.
Typetextarea
Address5Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the related person.
Typestring
Address5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the related person.
TypedateTime
BirthDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe related person’s birth date.
Typestring
FamilyName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the related person’s family name (Smith in Carol Smith Rodgers Andrews).
262
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
Typestring
FamilyName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the related person’s family name (Rodgers in Carol Smith RodgersAndrews).
Typestring
FamilyName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the related person’s family name (Andrews in Carol Smith RodgersAndrews).
Typestring
Gender__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe related person’s gender.
Typestring
GivenName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
263
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName5__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typestring
Language1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA language that can be used to communicate with the related person about the patient’shealth.
Typestring
Language2__c
264
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA language that can be used to communicate with the related person about the patient’shealth.
Typestring
Language3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA language that can be used to communicate with the related person about the patient’shealth.
Typestring
Language4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA language that can be used to communicate with the related person about the patient’shealth.
Typestring
Language5__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA language that can be used to communicate with the related person about the patient’shealth.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
265
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookupSort
DescriptionThe EHR related person ID. Limit: 255 characters.
Typetextarea
NameFull__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the related person’s full name.
Typereference
Patient__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe patient’s name. Lookup to EhrPatient__c.
Typetextarea
PhotoUrl__c
PropertiesCreate, Nillable, Update
DescriptionThe URL to a photo of the related person.
Typestring
PrefixName1__c
266
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first prefix in the related person’s name.
Typestring
PrefixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in the related person’s name.
Typestring
PrefixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in the related person’s name.
Typestring
Relationship__c
PropertiesCreate, Filter, Group, NillableSort, Update
DescriptionThe nature of the relationship between the patient and the related person.
Typestring
Role255__c
PropertiesCreate, Filter, Group, NillableSort, Update
DescriptionThe role of the related person. Limit: 255 characters.
Typetextarea
Role__c
PropertiesCreate, Nillable, Sort
DescriptionThe long text description of the role of the related person.
Typestring
SourceSystem__c
267
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, NillableSort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
Typestring
Specialty255__c
PropertiesCreate, Filter, Group, NillableSort, Update
DescriptionThe related person’s specialty. Limit: 255 characters.
Typetextarea
Specialty__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the related person’s specialty.
Typestring
SuffixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first suffix in the related person’s name.
Typestring
SuffixName2__c
268
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second suffix in the related person’s name.
Typestring
SuffixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third suffix in the related person’s name.
TypedateTime
Telecom1PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
TypedateTime
Telecom1PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
Typestring
Telecom1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.
Typestring
Telecom1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
269
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.
Typestring
Telecom1Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.
TypedateTime
Telecom2PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
TypedateTime
Telecom2PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
Typestring
Telecom2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.
Typestring
Telecom2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
270
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.
Typestring
Telecom2Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.
TypedateTime
Telecom3PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
TypedateTime
Telecom3PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
Typestring
Telecom3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.
Typestring
Telecom3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
271
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.
Typestring
Telecom3Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.
TypedateTime
Telecom4PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
TypedateTime
Telecom4PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
Typestring
Telecom4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.
Typestring
Telecom4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
272
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.
Typestring
Telecom4Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.
TypedateTime
Telecom5PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
TypedateTime
Telecom5PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.
Typestring
Telecom5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.
Typestring
Telecom5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
273
EhrRelatedPerson__cElectronic Health Record Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.
Typestring
Telecom5Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.
EhrVaccinationProtocol__c
Represents information about the protocol under which a vaccine is administered.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Authority255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe authority who published the protocol. Limit: 255 characters.
Typetextarea
Authority__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the authority who published the protocol. Limit: 255 characters.
Typetextarea
Description__c
274
EhrVaccinationProtocol__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the protocol under which a vaccine is administered.
Typestring
DoseReasonLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.
Typedouble
DoseSequence__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe dose number within a series of doses.
Typestring
DoseStatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that indicates whether the immunization event counts or doesn’tcount against the protocol.
Typestring
DoseStatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that indicates whether the immunization event counts or doesn’tcount against the protocol.
Typestring
DoseStatusReasonCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
275
EhrVaccinationProtocol__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe system-defined code that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.
Typestring
DoseStatusReasonSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines an explanation as to why an immunization event counts or doesn’tcount against the protocol.
Typestring
DoseStatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines whether an immunization event counts or doesn’t count againstthe protocol.
Typestring
DoseTargetCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the disease that the dose targets.
Typestring
DoseTargetLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the disease that the dose targets.
Typestring
DoseTargetSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the disease that the dose targets.
276
EhrVaccinationProtocol__cElectronic Health Record Custom Objects
DetailsField
Typereference
Immunization__c
PropertiesCreate, Filter, Group, Sort
DescriptionInformation about an immunization event.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR vaccination protocol ID. Limit: 255 characters.
277
EhrVaccinationProtocol__cElectronic Health Record Custom Objects
DetailsField
Typestring
Series__s
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the vaccine series: a possible path to achieve presumed immunity against adisease, within the context of an authority.
Typedouble
SeriesDoses__s
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe recommended number of doses for achieving immunity.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrVirtualDevice__c
Represents a group of related data items.
278
EhrVirtualDevice__cElectronic Health Record Custom Objects
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the virtual device.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
279
EhrVirtualDevice__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR virtual device ID. Limit: 255 characters.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
Description
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
280
EhrVirtualDevice__cElectronic Health Record Custom Objects
DetailsField
DescriptionThe most recent date when the integration system wrote the record from the source record.
EhrVirtualDeviceChannel__c
Represents a
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the virtual device channel.
Typestring
CodeLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the virtual device channel.
Typestring
CodeSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the virtual device channel.
Typereference
EhrVirtualDevice__c
281
EhrVirtualDeviceChannel__cElectronic Health Record Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA group of related data items. Lookup to EhrVirtualDevice__c.
Typeboolean
IsRestricted__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.
Typeboolean
IsVisibleOnPatientCard__c
PropertiesDefaulted on create, Filter, Group
DescriptionIndicates whether or not this field appears on the patient card.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
282
EhrVirtualDeviceChannel__cElectronic Health Record Custom Objects
DetailsField
Typetextarea
Metric__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of a piece of data reported by the device for the channel.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR virtual device channel name. Limit: 255 characters.
Typereference
Observation__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe data for the metric. Lookup to EhrObservation__c.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
Description
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
283
EhrVirtualDeviceChannel__cElectronic Health Record Custom Objects
DetailsField
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
284
EhrVirtualDeviceChannel__cElectronic Health Record Custom Objects
HEALTH CLOUD CUSTOM OBJECTS
CarePlanTemplate__c
Represents the template used to create a care plan including the problems, goals, and tasks that care coordinators use to manage andmitigate a medical condition.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create Filter, Group, Sort, Update
DescriptionIndicates whether the record is active or not.
Typereference
ClonedFrom__c
PropertiesCreate, Filter, Nillable, Group, Sort, Update
DescriptionIndicates where this template was cloned or copied from.
Typetextarea
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the template.
UsageUse this object to manage patient care templates.
285
CarePlanTemplateGoal__c
Represents a goal included in the care plan template.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create Filter, Group, Sort, Update
DescriptionIndicates whether the record is active or not.
Typetextarea
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the goal associated with the problem.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the care plan goal. Limit: 255 characters.
Typereference
OwnerId
PropertiesDefaulted on create, Filter, Group, Sort, Update
DescriptionID of the owner of the goal.
Typepicklist
Priority___c
286
CarePlanTemplateGoal__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update
DescriptionThe priority of the care plan goal such as low, normal, or high.
Typepicklistdouble
SortOrder___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionIndicates the sort order of goals in the list.
Typereference
TemplateProblem___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionName of the problem this goal is related to.
UsageUse this object to query and manage goals that are related to problems within a care plan template.
CarePlanTemplateProblem__c
Represents a problem included in the care plan template.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create Filter, Group, Sort, Update
287
CarePlanTemplateProblem__cHealth Cloud Custom Objects
DetailsField
DescriptionIndicates whether the record is active or not.
Typereference
CarePlanTemplate__c
PropertiesCreate, Filter,Group, Nillable, Sort, Update
DescriptionThe care plan template that the problem is related to.
Typetextarea
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the problem associated with the template.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the care plan problem. Limit: 255 characters.
Typereference
OwnerId
PropertiesDefaulted on create, Filter, Group, Sort, Update
DescriptionID of the owner of the problem.
Typepicklist
Priority___c
PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update
DescriptionThe priority of the care plan problem such as low, normal, or high.
Typedouble
SortOrder___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
288
CarePlanTemplateProblem__cHealth Cloud Custom Objects
DetailsField
DescriptionIndicates the sort order of problems in the list.
UsageUse this object to query and manage problems associated with a care plan template.
CarePlanTemplateTask__c
Represents a task that’s included in the care plan template.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create Filter, Group, Sort, Update
DescriptionIndicates whether the record is active or not.
Typepicklist
AssignedTo__c
PropertiesCreate, Filter, Group, Nillable,Restricted picklist, Sort, Update
DescriptionName of the person who’s assigned to the task.
Typereference
CarePlanTemplateGoal__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionName of the goal associated with the task.
289
CarePlanTemplateTask__cHealth Cloud Custom Objects
DetailsField
Typetextarea
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the task.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the care plan problem. Limit: 255 characters.
Typedouble
Offset___c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionAdds an offsetDate to the date selected for a task in the care plan. Tasks that have an offsetdate add the assigned offset to the task start date. For example, if the care plan start date isDecember 9 and a task offset is +7 days, the task’s due date is December 16.
Typepicklist
Priority___c
PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update
DescriptionThe priority of the care plan task such as low, normal, or high.
Typedouble
SortOrder___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionIndicates the sort order of tasks in the list.
Typepicklist
Status___c
PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update
290
CarePlanTemplateTask__cHealth Cloud Custom Objects
DetailsField
DescriptionThe status of the care plan task such as in progress, complete, or new.
Typestring
Subject___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe subject or name of the task.
Typepicklist
Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of task.
UsageUse this object to query and manage tasks associated with a care plan template.
AccountAccountRelation__c
Represents a one-to-one relationship between two accounts, each with a distinct role in relation to the other.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionAccount that RelatedAccount__c is related from.
291
AccountAccountRelation__cHealth Cloud Custom Objects
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the relationship between accounts is active (true) or not (false). Thedefault checkbox value is selected.
Typedate
EndDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe last date when the two accounts are related.
Typestring
ExternalId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external ID that inhibits any duplicate definitions from FromAccount- Role -ToAccount.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the relationship between the accounts. Limit: 255 characters.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionID of the user who created the relationship record.
Typereference
RelatedAccount__c
PropertiesFilter, Group, Nillable, Sort
292
AccountAccountRelation__cHealth Cloud Custom Objects
DetailsField
DescriptionAccount that Account__c is related to.
Typereference
Role__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe role of the relationship.
Typedate
StartDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first date when the relationship between accounts is valid (not when the object iscreated).
UsageThis resource tracks each account’s relationship to the other.
CandidatePatient__c
Represents the demographics and other administrative information about a patient who’s receiving health-related services.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Address1City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
293
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address1Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address1EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address1Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address1Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address1PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address1StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
294
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address1State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address1Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient. Use is optional based on source data.
Typestring
Address1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address2City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address2Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address2EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
295
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address2Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address2Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address2PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address2StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address2State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address2Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient. Use is optional based on source data.
296
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address3City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address3Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address3EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address3Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address3Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
297
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address3PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address3StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address3State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address3Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient. Use is optional based on source data.
Typestring
Address3Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address4City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
298
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address4Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address4EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
Typestring
Address4Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address4Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address4PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address4StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid
299
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address4State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address4Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient. Use is optional based on source data.
Typestring
Address4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
Typestring
Address5City__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe city in an address for the patient.
Typestring
Address5Country__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe country in an address for the patient.
TypedateTime
Address5EndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when an address for the patient is valid.
300
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address5Line1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first line of a street address for the patient.
Typestring
Address5Line2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second line of a street address for the patient.
Typestring
Address5PostalCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe postal code of an address for the patient.
TypedateTime
Address5StartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when an address for the patient is valid.
Typestring
Address5State__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe state in an address for the patient.
Typetextarea
Address5Text__c
PropertiesCreate, Nillable, Update
DescriptionA complete address for the patient. Use is optional based on source data.
301
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Address5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home or office related to an address for the patient.
TypedateTime
BirthDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe patient’s birth date.
Typestring
Communication1Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication1Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication2Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
302
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication2Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication3Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication3Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
303
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication4Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication4Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typestring
Communication5Code__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.
Typestring
Communication5Label__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
304
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.
Typestring
Communication5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.
Typeboolean
Deceased__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.
Typestring
FamilyName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).
Typestring
FamilyName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).
Typestring
FamilyName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).
305
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
GenderCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.
Typestring
GenderLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.
Typestring
GenderSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.
Typestring
GivenName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName3__c
306
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typestring
GivenName4__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)
Typestring
GivenName5__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
307
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
MaritalStatusCode__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system-defined code that represents the patient’s most recent civil marital status.
Typestring
MaritalStatusLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe human-readable label that represents the patient’s most recent civil marital status.
Typestring
MaritalStatusSystem__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines the patient’s most recent civil marital status.
Typestring
MedicalRecordNumber__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe medical record number used to identify a patient.
Typeboolean
MultipleBirth__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.
Typestring
Name
308
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionThe EHR ADT patient ID. Limit: 255 characters.
Typetextarea
Name__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of a name associated with the patient.
Typestring
Organization255__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe organization on behalf of which a patient contact is acting, for which the patient contactis working, or that’s acting as the custodian of the patient record. Limit: 255 characters.
Typetextarea
Organization__c
PropertiesCreate, Nillable, Update
DescriptionThe long text description of the organization on behalf of which a patient contact is acting,for which the patient contact is working, or that’s acting as the custodian of the patientrecord.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
Description
Typetextarea
PhotoUrl__c
PropertiesCreate, Nillable, Update
DescriptionThe URL for a photograph of the patient.
309
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
PrefixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first prefix in a patient’s name.
Typestring
PrefixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in a patient’s name.
Typestring
PrefixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in a patient’s name.
Typestring
SourceSystem__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionA name that identifies the system that created the record and owns update rights to it.
Typestring
SourceSystemId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe ID of an external record. This field can’t be encrypted.
TypedateTime
SourceSystemModified__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe most recent date when the integration system wrote the record from the source record.
310
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
SuffixName1__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first suffix in a patient’s name.
Typestring
SuffixName2__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe second prefix in a patient’s name.
Typestring
SuffixName3__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe third prefix in a patient’s name.
TypedateTime
Telecom1PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom1PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom1System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
311
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.
Typestring
Telecom1Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.
Typestring
Telecom1Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom2PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom2PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom2System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.
312
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Telecom2Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.
Typestring
Telecom2Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom3PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom3PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom3System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.
Typestring
Telecom3Use__c
313
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.
Typestring
Telecom3Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom4PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom4PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom4System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.
Typestring
Telecom4Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
314
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.
Typestring
Telecom4Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
TypedateTime
Telecom5PeriodEndDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
TypedateTime
Telecom5PeriodStartDate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.
Typestring
Telecom5System__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.
Typestring
Telecom5Use__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.
315
CandidatePatient__cHealth Cloud Custom Objects
DetailsField
Typestring
Telecom5Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe content details, such as the phone number, that can be used to contact the patient.
CardViewDropdown__c
Defines a tab navigation menu option on the patient card to open standard and custom pages or URLs as either primary or secondarytabs. Clicking an item in the menu opens a new tab or subtab for that patient.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Category__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName of the parent category that contains child navigation items. The category name actsas a heading and isn’t a clickable navigation link.
Typestring
Name
PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort
DescriptionDescibes the menu navigation item.
Typestring
ParamString__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
316
CardViewDropdown__cHealth Cloud Custom Objects
DetailsField
DescriptionAdd any extra URL parameters to the existing Visualforce page or URL to open the new tab.
Typestring
RecOpenType__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionSpecifies the type of tab to use for this page: Primary or Subtab. A primary tab is the mainitem to work on. A subtab is related to an item on a primary tab.
Typestring
SubCategory__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName of the child category in the menu list. This text is the clickable link that opens the pageor tab.
Typestring
Type__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionContent type of the new page. Specify VFpage or URL.
Typestring
URL__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe URL to access the page.
CarePlanGoal__c
Represents the intended objectives of carrying out a care plan.
Supported Callscreate(), delete(),describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
317
CarePlanGoal__cHealth Cloud Custom Objects
Fields
DetailsField
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
Typereference
CarePlanProblem__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe health problem that this goal addresses.
Typetextarea
Description__c
PropertiesCreate, Nillable, Update
DescriptionA long text description of the care plan.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record.
• Due date of the most recently closed task associated with the record.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
318
CarePlanGoal__cHealth Cloud Custom Objects
DetailsField
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the care plan goal. Limit: 255 characters.
Typestring
PercentBar___c
PropertiesFilter, Nillable, Sort
DescriptionPercent completed.
Typepicklist
Priority___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe priority of the care plan goal. Picklist values: Low, Medium, and High.
Typepercent
Progress___c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionProgress toward achieving the care plan goal.
UsageDevelopers can use an integration to build CarePlanGoal__c from data in EhrCarePlanGoal__c. Not required.
319
CarePlanGoal__cHealth Cloud Custom Objects
CarePlanGoal__History
Represents a standard Salesforce history object used to track previous values for any given field on CarePlanGoal__c.
Supported CallsdescribeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields
DetailsField
Typepicklist
Field
PropertiesFilter, Group, Restricted picklist, Sort
DescriptionThe field whose history is tracked.
TypeanyType
NewValue
PropertiesNillable, Sort
DescriptionThe new value of the field whose history is tracked.
TypeanyType
OldValue
PropertiesNillable, Sort
DescriptionThe previous value of the field whose history is tracked.
Typereference
ParentId
PropertiesFilter, Group, Sort
Description
UsageHistory tracking is enabled for the object. Admins can configure history tracking for fields.
320
CarePlanGoal__HistoryHealth Cloud Custom Objects
CarePlanProblem__c
Represents the conditions, problems, concerns, diagnoses, and so on, that this plan manages and mitigates.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typereference
CarePlanTemplate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe care plan template associated with the problem.
Typereference
CarePlan__c
PropertiesCreate, Filter, Group, Sort
DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.
Typetextarea
Description__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA description of the care plan problem.
Typedate
LastActivityDate
PropertiesFilter, Group, Nillable, Sort
DescriptionWhichever of the following is the most recent:
• Due date of the most recent event logged against the record
• Due date of the most recently closed task associated with the record
321
CarePlanProblem__cHealth Cloud Custom Objects
DetailsField
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe timestamp indicating when the user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe timestamp indicating when the current user last viewed this record.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the care plan problem. Limit: 255 characters.
Typepicklist
Priority___c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe priority of the care plan problem. Picklist values: Low, Medium, and High.
UsageDevelopers can use an integration to build CarePlanProblem__c from data in EhrCarePlanConcern__c. Not required.
SEE ALSO:
CarePlanGoal__c
CarePlanProblem__History
Represents a standard Salesforce object for tracking previous values of a given field on an instance of a given object. Enabled in theHealth Cloud managed package at the object level only.
322
CarePlanProblem__HistoryHealth Cloud Custom Objects
Supported CallsdescribeSObjects(), getDeleted(), getUpdated(), retrieve(), query()
Fields
DetailsField
Typepicklist
Field
PropertiesFilter, Group, Restricted picklist, Sort
DescriptionThe field whose history is tracked.
TypeanyType
NewValue
PropertiesNillable, Sort
DescriptionThe new value of the field whose history is tracked.
TypeanyType
OldValue
PropertiesNillable, Sort
DescriptionThe previous value of the field whose history is tracked.
Typereference
ParentId
PropertiesFilter, Group, Sort
DescriptionID of the parent object.
UsageAdmin users of the package can enable history tracking for fields.
ConditionToHCCCodeMapping__c
Represents a mapping of patient conditions to Hierarchical Condition Category (HCC) codes.
323
ConditionToHCCCodeMapping__cHealth Cloud Custom Objects
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search ( ),undelete(), update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether this condition to HCC mapping is active and available for use.
Typestring
ConditionCode__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionA comma-separated list of conditions that apply to the patient.
Typestring
HCCCode__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionHCC codes that apply to the patient’s condition.
Typedouble
ValidFrom__c
PropertiesCreate, Filter, Sort, Update
DescriptionThe year in which the HCC codes become valid.
Typedouble
ValidThrough__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe last year in which the HCC codes are valid.
324
ConditionToHCCCodeMapping__cHealth Cloud Custom Objects
DetailsField
Typestring
YearConditionCodeHCCCode__c
PropertiesCreate, Filter, Group, idLookup, Sort, Unique, Update
DescriptionUnique key for the record.
UsageUse this object to map the EHR condition (diagnosis) codes to the HCC codes.
ContactContactRelation__c
Represents a relationship between two contacts, each with a distinct role in relation to the other.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the relationship is active (true) or not (false). The default checkboxvalue is selected.
Typereference
Contact__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionContact that RelatedContact__c is related from.
Typedate
EndDate__c
325
ContactContactRelation__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe last date when the relationship between contacts is valid.
Typestring
ExternalId__c
PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionAn external ID that inhibits any duplicate definitions from FromContact - Role -ToContact.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the relationship between the contacts. Limit: 255 characters.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
Description
Typereference
RelatedContact__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionContact that RelatedContact__c is related to.
Typereference
Role__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionRole that describes how RelatedContact__c is related to Contact__c
Typedate
StartDate__c
326
ContactContactRelation__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe first date when the relationship between the contacts is valid (not when the object wascreated).
UsageThis resource tracks each contact’s relation to the other.
CrossObjectRelationship__c
Represents a relationship between two objects (for example, patient Account and EhrPatient__c) used in patient list view pages.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
FromObject__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe related from object.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
327
CrossObjectRelationship__cHealth Cloud Custom Objects
DetailsField
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the relationship between the objects. Limit: 255 characters.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionThe owner of the record.
Typestring
Relationship__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe relationship between the objects.
Typestring
ReverseRelationship__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe reverse relationship between the objects.
Typestring
ToObject__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe related to object.
328
CrossObjectRelationship__cHealth Cloud Custom Objects
CustomFieldSets__c
Represents a custom grouping of fields
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()
Fields
DetailsField
Typetextarea
ExcludedFields__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionFields that aren’t included in the field set.
Typestring
FieldSetLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLabel for the field set.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Sort, Update
DescriptionThe name of the custom field set. Limit: 255 characters.
Typestring
SObjectName
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the sObject. Limit: 255 characters.
Typeboolean
TwoColumnLayout
329
CustomFieldSets__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionWhether the layout is two-column (true) or not (false).
CustomLabelConfig__c
Represents a custom label in Health Cloud.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Sort, Update
DescriptionThe name of the custom label configuration. Limit: 255 characters.
Typestring
NewLabel__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName of the new label.
Typestring
ObjectFieldName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the object field.
330
CustomLabelConfig__cHealth Cloud Custom Objects
DetailsField
Typestring
ObjectName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the object.
Typestring
ObjectRecordType__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe object record type.
Typestring
RelationshipName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the relationship.
Typestring
ViewName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the view.
FilterColumn__c
Represents the column used by filter criteria for the patient segmentation functionality.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
331
FilterColumn__cHealth Cloud Custom Objects
Fields
DetailsField
Typestring
FieldApi__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe selected field.
Typestring
FieldLabel__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLabel of the selected field.
Typereference
FilterCriterion__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe field criterion.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe filter column name. Limit: 255 characters.
Typetextarea
ObjectName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionA long text description of the name of the object.
Typedouble
Order__c
PropertiesCreate, Filter, Nillable, Sort, Update
332
FilterColumn__cHealth Cloud Custom Objects
DetailsField
DescriptionOrder in which the field appears.
FilterCondition__c
Represents the condition used by filter criteria for the patient segmentation functionality.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
FieldName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe name of the field.
Typereference
FieldCriterion__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe field criterion.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the filter condition. Limit: 255 characters.
Typetextarea
ObjectName__c
333
FilterCondition__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the object.
Typestring
Operator__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe filter criteria operator.
Typedouble
RowNumber__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionNumber of rows.
Typestring
SRowNumber__c
PropertiesFilter, Nillable, Sort
DescriptionThe number of rows to display.
Typestring
Type__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe type of filter condition.
Typestring
Value__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionA value entered in the filter condition.
334
FilterCondition__cHealth Cloud Custom Objects
FilterCriterion__c
Represents the filter criteria for the patient segmentation functionality. Consists of a list of filter conditions and a list of columns to bedisplayed as part of the filter view on the patient list view page.
Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typetextarea
Grouping__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionGrouping of the filter items.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the filter criterion. Limit: 255 characters.
335
FilterCriterion__cHealth Cloud Custom Objects
DetailsField
Typetextarea
ObjectName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the object.
Typereference
OwnerId
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionID of the record’s owner.
PatientCardViewConfiguration__c
Represents configuration options for the patient card.
Supported Callscreate(), delete(), query(), retrieve(), search(), undelete(), update()
Fields
DetailsField
Typestring
FieldName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName of the field that contains the information to display on the patient card.
Typestring
FriendlyName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName that appears as a title on the patient card.
336
PatientCardViewConfiguration__cHealth Cloud Custom Objects
DetailsField
Typeboolean
IsActive__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionIndicates whether this field is appears on the patient card.
Typeboolean
IsAscending__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionIndicates whether results appear in ascending order.
Typestring
LanguageCode__c
PropertiesFilter, Nillable, Sort
DescriptionCode for the language of the item on the patient card.
Typepicklist
Language__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist Sort, Update
DescriptionLanguage used for the item on the patient card.
Typedouble
Limit__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionIndicates the maximum number of results to display in the field.
Typestring
ObjectName__c
PropertiesCreate, Filter, Group, Sort, Update
337
PatientCardViewConfiguration__cHealth Cloud Custom Objects
DetailsField
DescriptionName of the object that contains the field to show on the patient card. Use the exact spellingof the object name to ensure correct results.
Typestring
OverrideFilterField__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionName of the custom filter field to replace the delivered one.
Typestring
PatientAccountLookup__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionName of the lookup to display on the patient card when multiple lookups to Account exist.The default for this field is Account__c.
Note: To use delivered Account lookups for standard objects like Contact or Task, youmust append Id to the lookup field name. For example, to configure a lookup fromContact to Account, use AccountId in this field. Similarly, for a lookup from Task toWhat, use WhatId.
Typestring
SortBy__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the field used to define the order in which the results appear.
Typedouble
SortOrder__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionIndicates the vertical order in which this field appears on the patient card.
UsageThis resource lets you customize the patient card and add the fields of your choice.
338
PatientCardViewConfiguration__cHealth Cloud Custom Objects
Program__c
Represents information about the program that the company is participating in. Programs include Medicare Chronic Care Management(CCM), Medicare accountable care organizations Hierarchical Condition Category (HCC) risk scoring, among others.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()
Fields
DetailsField
Typedate
EndDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date when the program ends.
Typeboolean
IsActive__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the program is active.
Typecurrency
Rate__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionThe reimbursement rate for the measurement period of a patient’s program.
Typestring
ReportName__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionName of the Wave report that uses this information.
339
Program__cHealth Cloud Custom Objects
DetailsField
Typedate
StartDate__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe date when the program begins.
Typedouble
Target__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionTarget time to be spent with the patient for the measurement period.
Typepicklist
TimeSpan__c
PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update
DescriptionThe measurement period for the program. Picklist values: Annually, Monthly, Quarterly, andWeekly.
Typepicklist
UnitOfMeasure__c
PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update
DescriptionUnit of measurement for the time spent with the patient during the measurement perioddefined in the Target field. Picklist values: Minutes and Seconds.
Typestring
UserRoleField__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionTypes of users that qualify for evaluation during a time period, if applicable.
UsageUse this object to manage information about the programs that a company is participating in.
340
Program__cHealth Cloud Custom Objects
ProgramPatientAffiliation__c
Represents the program that the patient is affiliated with.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()
Fields
DetailsField
Typereference
Account__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to the Account object.
Typedate
EndDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date when the patient’s enrollment in the program ends.
Typeboolean
IsActive__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the enrollment of the person in the associated program is active.
Typereference
Program__c
PropertiesCreate, Filter, Group, Sort
DescriptionThe program in which the patient is enrolled.
Typeboolean
Recalculate__c
341
ProgramPatientAffiliation__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether new and relevant information about the patient has been received thattriggers a recalculation of the appropriate program metrics.
Typereference
Provider
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionName of the physician or other healthcare provider.
Typedate
StartDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date when the patient’s enrollment in the program ends.
Typepicklist
Status__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update
DescriptionThe status of the patient’s Medicare Chronic Care Management (CCM) program. Picklistvalues: Declined, In Progress, In Program, and Potential. The default is In Progress.
UsageUse this object to manage a patient’s enrollment information for a particular program.
ProgramPatientSummary__c
Represents a record that contains calculated values for the relevant program that the patient is enrolled in.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()
342
ProgramPatientSummary__cHealth Cloud Custom Objects
Fields
DetailsField
Typedouble
Age__c
PropertiesCreate, Filter, Sort, Update
DescriptionThe patient’s age in years as of December 31 for the year being calculated.
Typestring
AgeBand__c
PropertiesFilter, Nillable, Sort
DescriptionThe age group in which the patient belongs. For example, 35–44, 55–59, and so on.
Typetextarea
Conditions__c
PropertiesCreate, Nillable, Update
DescriptionA list of Hierarchical Condition Category (HCC) codes associated with the patient.
Typeboolean
DisabilityStatus__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the patient is considered disabled according to the Centers for Medicareand Medicaid Services (CMS) guidelines.
Typedate
EffectiveDate__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe date when the risk score was calculated.
EnrollmentType__c
Typepicklist
Gender__c
343
ProgramPatientSummary__cHealth Cloud Custom Objects
DetailsField
PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update
DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.
Typestring
HCCCodes__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionHCC codes that apply to the patient for the year.
Typeboolean
Institution__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the patient is in an institution.
Typeboolean
LowIncome__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the patient falls within low-income guidelines.
Typestring
Month__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe month that the time spent applies.
Typeboolean
MostRecent__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether this record contains the most recent calculation for the measurementperiod.
344
ProgramPatientSummary__cHealth Cloud Custom Objects
DetailsField
Typeboolean
NewPatient__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether the person is a new Medicare patient or a continued enrollee.
Typestring
NumberOfConditions__c
PropertiesCreate, Filter, Group, NillableSort, Update
DescriptionThe number of HCC codes associated with the patient.
Typereference
ProgramPatientAffiliation__c
PropertiesCreate, Filter, Group, NillableSort, Update
DescriptionLookup to the ProgramPatientAffiliation object.
Typedouble
RiskScore__c
PropertiesCreate, Filter, NillableSort, Update
DescriptionThe patient’s calculated HCC risk score.
Typepicklist
Stage__c
PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The stage of the Medicare Chronic Care Management (CCM) program that the patient is in.Picklist values: Declined, In Process, In Program, and Potential.
Typedouble
TimeSpent__c
PropertiesCreate, Filter, Nillable, Sort, Update
345
ProgramPatientSummary__cHealth Cloud Custom Objects
DetailsField
DescriptionThe total time spent with the patient on qualifying activities during the measurement period.
Typestring
Unique__c
PropertiesFilter, Nillable, Sort
DescriptionA key used for time calculations.
Typestring
Year__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe year that the risk score applies to.
UsageUse this object to store calculated information for a patient’s program.
Provider__c
Represents a person providing healthcare.
Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()
Fields
DetailsField
Typeboolean
Active__c
PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update
DescriptionIndicates whether this provider is actively practicing.
346
Provider__cHealth Cloud Custom Objects
DetailsField
Typereference
EHRPractitioner__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to the EhrPractictioner object.
Typereference
RelatedContact__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to the Contact object if the record originates from a contact relationship.
Typereference
RelatedUser__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionLookup to the User object if the record originates from a user.
TimelineViewConfiguration__c
Represents an event type on the timeline view in the patient care console.
Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), search(), undelete(), update(), upsert()
Fields
DetailsField
Typestring
DetailField__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionInformation from this field appears in the hover view on the timeline.
347
TimelineViewConfiguration__cHealth Cloud Custom Objects
DetailsField
Typestring
FriendlyName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe human-readable name of the timeline view configuration.
Typestring
GraphicalIcon__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe icon used to depict the event on the timeline.
Typeboolean
IsActive__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionIndicates whether this field appears on the timeline.
TypedateTime
LastReferencedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed a related record.
Typestring
LanguageCode__c
PropertiesFilter, Nillable, Sort
DescriptionCode for the language of the item on the timeline.
Typepicklist
Language__c
PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist Sort, Update
DescriptionLanguage used for the item on the timeline.
348
TimelineViewConfiguration__cHealth Cloud Custom Objects
DetailsField
TypedateTime
LastViewedDate
PropertiesFilter, Nillable, Sort
DescriptionThe time stamp that indicates when the current user last viewed this record.
Typestring
Name
PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
DescriptionThe name of the timeline view configuration. Limit: 255 characters.
Typestring
ObjectCategory__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the category of objects that this event is related to. By default, all pre-configuredobjects are either Engagement Data or Medical Record Data.
Typestring
ObjectName__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe name of the object.
Typestring
PatientAccountLookup__c
PropertiesCreate, Filter, Group, Nillable, Sort, Update
DescriptionThe API name of the field that looks up to Account (Patient). The default for this field isAccount__c.
Note:
To use delivered Account lookups for standard objects like Contact or Task, you must appendId to the lookup field name. For example, to configure a lookup from Contact to Account, useAccountId in this field. Similarly, for a lookup from Task to What, use WhatId.
349
TimelineViewConfiguration__cHealth Cloud Custom Objects
DetailsField
Typestring
PositionField__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionThe date or datetime field that the system uses to position the event horizontally on thecorrect date on the timeline.
Typeboolean
ShowOnLoad__c
PropertiesCreate, Filter, Group, Sort, Update
DescriptionControls the option to only show a subset of events when the timeline first appears in theconsole.
Typedouble
SortOrder__c
PropertiesCreate, Filter, Nillable, Sort, Update
DescriptionIndicates the vertical order that the events appear when there are other events with thesame date on the timeline.
350
TimelineViewConfiguration__cHealth Cloud Custom Objects
HEALTH CLOUD CUSTOM METADATA TYPES
Custom metadata is customizable, deployable, packageable, and upgradeable application metadata.
GroupRecordTypeMapper
Maps a new custom Group record type to the standard Group record type from Financial Services Cloud.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), describeSObjects(), query(), retrieve(), search()
DetailsField
Typestring
AccountRecordType__c
PropertiesFilter, Group, Nillable, Sort
DescriptionThe name of your new custom Group record type being mapped to the Financial ServicesCloud Group record type.
Note: This field is for Salesforce internal-use only. By default, this field doesn’t appear onany page layout.
Typestring
AccountRecordTypeNamespace__c
PropertiesFilter, Group, Nillable, Sort
DescriptionNamespace for Account record type being mapped.
IndividualRecordTypeMapper
Maps a new custom Individual record type to the standard Individual record type from Financial Services Cloud.
Note: New custom fields can’t be added to managed custom metadata types.
351
Supported CallsdescribeLayout(), describeSObjects(), query(), retrieve(), search()
DetailsField
Typestring
AccountRecordTypeNamespace__c
PropertiesFilter, Group, Nillable, Sort
DescriptionNamespace for Account record type being mapped.
Typestring
AccountRecordType__c
PropertiesFilter, Group, Nillable, Sort
DescriptionThe name of your new custom Individual record type being mapped to the Financial ServicesCloud Individual record type.
Note: This field is for Salesforce internal-use only. By default, this field doesn’t appear onany page layout.
Typestring
ContactRecordTypeNamespace__c
PropertiesFilter, Group, Nillable, Sort
DescriptionNamespace for Contact record type being mapped.
Typestring
ContactRecordType__c
PropertiesFilter, Group, Nillable, Sort
DescriptionContact record type being mapped to the Financial Services Cloud Individual record type.
Typestring
DetailPage__c
PropertiesFilter, Group, Nillable, Sort
DescriptionSalesforce internal-use only.
352
IndividualRecordTypeMapperHealth Cloud Custom Metadata Types
DetailsField
Typestring
IndividualType__c
PropertiesFilter, Group, Nillable, Sort
DescriptionType of Individual being mapped.
Typestring
LeadRecordTypeNamespace__c
PropertiesFilter, Group, Nillable, Sort
DescriptionLead namespace for your custom record type’s org.
Typestring
LeadRecordType__c
PropertiesFilter, Group, Nillable, Sort
DescriptionLead Record Type to be used when converting Lead records. Leave this field blank to useany record type. All available record types are converted to an Individual record type unlessthere is another mapping specified.
RiskScoreAgeBandContinuedEnrollee
Mapping used to indicate risk score based on age and continued enrollment status.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typedouble
AgeBandFrom__c
PropertiesFilter, Sort
DescriptionMinimum age in a defined group.
353
RiskScoreAgeBandContinuedEnrolleeHealth Cloud Custom Metadata Types
DetailsField
Typedouble
AgeBandTo__c
PropertiesFilter, Sort
DescriptionMaximum age in a defined group.
Typedouble
CommunityFBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityFBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.
Typedouble
CommunityNonDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.
Typedouble
CommunityNonDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.
Typedouble
CommunityPBDualAged__c
354
RiskScoreAgeBandContinuedEnrolleeHealth Cloud Custom Metadata Types
DetailsField
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityPBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.
Typedouble
Community__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home.
Typepicklist
Gender__c
PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort
DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.
Typedouble
Institutional__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.
Typeboolean
IsActive__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether this record is active.
355
RiskScoreAgeBandContinuedEnrolleeHealth Cloud Custom Metadata Types
DetailsField
Typestring
YearSpan__c
PropertiesFilter, Group, Sort
DescriptionCalendar year that this metadata applies to.
RiskScoreAgeBandNewEnrollee
Mapping used to indicate risk score based on age and new enrollment status.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typedouble
AgeBandFrom__c
PropertiesFilter, Sort
DescriptionMinimum age in a defined group.
Typedouble
AgeBandTo__c
PropertiesFilter, Sort
DescriptionMaximum age in a defined group.
Typeboolean
CSNP__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionWhether the patient is part of a CSNP (Chronic Condition Special Needs Plan).
356
RiskScoreAgeBandNewEnrolleeHealth Cloud Custom Metadata Types
DetailsField
Typepicklist
Gender__c
PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort
DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.
Typeboolean
IsActive__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether this record is active.
Typedouble
MedicaidNonOriginallyDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.
Typedouble
MedicaidOriginallyDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas due to disability.
Typedouble
NonMedicaidNonOriginallyDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.
Typedouble
NonMedicaidOriginallyDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
357
RiskScoreAgeBandNewEnrolleeHealth Cloud Custom Metadata Types
DetailsField
DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas due to disability.
Typestring
YearSpan__c
PropertiesFilter, Group, Sort
DescriptionCalendar year that this metadata applies to.
RiskScoreHCCCode
Maps risk score to HCC codes.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typedouble
Community__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home.
Typedouble
CommunityFBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityFBDualDisabled__c
358
RiskScoreHCCCodeHealth Cloud Custom Metadata Types
DetailsField
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.
Typedouble
CommunityNonDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.
Typedouble
CommunityNonDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.
Typedouble
CommunityPBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
Description
Typedouble
CommunityPBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.
Typestring
ConditionCategory__c
PropertiesFilter, Group, Sort
DescriptionIndicates the medical condition category that the HCC belongs to.
359
RiskScoreHCCCodeHealth Cloud Custom Metadata Types
DetailsField
Typestring
Description__c
PropertiesFilter, Group, Nillable, Sort
DescriptionDescription of the medical condition category.
Typestring
HCCCode__c
PropertiesFilter, Group, Nillable, Sort
DescriptionThe HCC code related to the condition.
Typedouble
Institutional__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.
Typeboolean
IsActive__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether this record is active.
Typestring
OverriddenHCCCodes__c
PropertiesFilter, Group, Nillable, Sort
DescriptionIndicates which HHC codes are overridden by the value in HCCCode__c.
Typestring
YearSpan__c
PropertiesFilter, Group, Sort
DescriptionCalendar year that this metadata applies to.
360
RiskScoreHCCCodeHealth Cloud Custom Metadata Types
RiskScoreDiseaseInteraction
Maps risk scores to disease interactions.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typeboolean
ApplyIfDisabled__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates a disabled-disease interaction instead of a disease-disease interaction.
Typedouble
Community__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home.
Typedouble
CommunityFBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityFBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.
Typedouble
CommunityNonDualAged__c
361
RiskScoreDiseaseInteractionHealth Cloud Custom Metadata Types
DetailsField
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.
Typedouble
CommunityNonDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.
Typedouble
CommunityPBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityPBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.
Typestring
HasConditions__c
PropertiesFilter, Group, Nillable, Sort
DescriptionIndicates that there are conditions or HCC codes that interact with either the disabledstatus or a part of the disease-disease interaction.
Typedouble
Institutional__c
PropertiesDefaulted on create, Filter, Nillable, Sort
362
RiskScoreDiseaseInteractionHealth Cloud Custom Metadata Types
DetailsField
DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.
Typestring
InteractingConditions__c
PropertiesFilter, Group, Nillable, Sort
DescriptionIndicates conditions that interact with the conditions found in HasConditions__c basedon disease-disease interactions.
Typeboolean
IsActive__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether this record is active.
Typestring
YearSpan__c
PropertiesFilter, Group, Sort
DescriptionCalendar year that this metadata applies to.
RiskScoreMedicaidInteractions
Maps risk scores to Medicaid and originally disabled interactions.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typedouble
Community__c1
PropertiesDefaulted on create, Filter, Nillable, Sort
363
RiskScoreMedicaidInteractionsHealth Cloud Custom Metadata Types
DetailsField
DescriptionIndicates that the patient lives at home.
Typedouble
CommunityFBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.
Typedouble
CommunityFBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a full-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.
Typedouble
CommunityNonDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.
Typedouble
CommunityNonDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.
Typedouble
CommunityPBDualAged__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.
364
RiskScoreMedicaidInteractionsHealth Cloud Custom Metadata Types
DetailsField
Typedouble
CommunityPBDualDisabled__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.
Typeboolean
Disabled__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionPatient is disabled.
Typepicklist
Gender__c
PropertiesDefaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.
Typedouble
Institutional__c
PropertiesDefaulted on create, Filter, Nillable, Sort
DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.
Typeboolean
IsActive__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether this record is active.
Typeboolean
Medicaid__c
PropertiesDefaulted on create, Filter, Group, Sort
365
RiskScoreMedicaidInteractionsHealth Cloud Custom Metadata Types
DetailsField
DescriptionIs eligible for Medicaid.
Typeboolean
OriginallyDisabled__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionOriginal reason for Medicare entitlement. Picklist values: Age and disabled.
Typestring
YearSpan__c
PropertiesFilter, Group, Sort
DescriptionCalendar year that this metadata applies to.
HealthCloudSetting
Holds mappings for field sets and other customizable elements in Health Cloud. To change a delivered setting, deactivate the setting,clone it, and make the new setting active.
Note: New custom fields can’t be added to managed custom metadata types.
Supported CallsdescribeLayout(), query(), retrieve()
DetailsField
Typeboolean
Active__c
PropertiesDefaulted on create, Filter, Group, Sort
DescriptionIndicates whether the record is active.
Typestring
SettingName__c
PropertiesFilter, Group, Sort
366
HealthCloudSettingHealth Cloud Custom Metadata Types
DetailsField
DescriptionName of the configuration setting or value that is mapped.
Typestring
SettingValue__c
PropertiesFilter, Group, Sort
DescriptionConfiguration value for a particular setting.
367
HealthCloudSettingHealth Cloud Custom Metadata Types