health cloud object reference guide · pdf file• egypt • el salvador • ......

Salesforce Health CloudDeveloper Guide

Salesforce, Spring ’18

@salesforcedocsLast updated: March 23, 2018

https://twitter.com/salesforcedocs

© Copyright 2000–2018 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 Developer Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Custom Fields on Standard Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Electronic Health Record Custom Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Health Cloud Custom Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292Health Cloud Custom Metadata Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Storing HL7 Data in Salesforce Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

HEALTH CLOUD DEVELOPER GUIDE

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

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.

Note: The API version for objects included in the Health Cloud packages is one versionbehind core Salesforce. For example, if your org’s API version is 41, the packaged Health Cloudelements including custom objects, components, classes, and triggers are API version 40.

Custom Fields on Standard Objects

Account Custom FieldsCustom 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.

Typepicklist

IndividualType__c


1

https://developer.salesforce.com/docs/atlas.en-us.212.0.object_reference.meta/object_reference/

DetailsField

DescriptionIdentifier for the individual, such as group or individual.

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typereference

PrimaryContact__c

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 FieldsCustom fields extend the standard Contact object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typestring

Age__c


DescriptionAge. Calculated from Contact.Birthdate.

Typestring

BirthDate__c

2

Contact Custom FieldsHealth Cloud Developer Guide

DetailsField


DescriptionDate of birth.

Typepicklist

CountryOfBirth__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionIndividual’s country of birth.

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

3


DetailsField

• Bosnia and Herzegovina

• Botswana

• Bouvet Island

• Brazil

• British Indian Ocean Territory

• Brunei Darussalam

• Bulgaria

• Burkina Faso

• Burundi

• Cambodia

• 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

4


DetailsField

• El Salvador

• Equatorial Guinea

• Eritrea

• Estonia

• Ethiopia

• Falkland Islands (Malvinas)

• Faroe Islands

• Fiji

• Finland

• France

• 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

5


DetailsField

• Ireland

• Isle of Man

• Israel

• Italy

• Jamaica

• Japan

• Jersey

• Jordan

• Kazakhstan

• Kenya

• 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

6


DetailsField

• Monaco

• Mongolia

• Montenegro

• Montserrat

• Morocco

• Mozambique

• Myanmar

• Namibia

• Nauru

• Nepal

• 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

7


DetailsField

• 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

• 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

8


DetailsField

• Trinidad and Tobago

• Tunisia

• Turkey

• Turkmenistan

• Turks and Caicos Islands

• Tuvalu

• Uganda

• Ukraine

• United Arab Emirates

• United Kingdom

• 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


DescriptionGender. Valid values:

• Female

• Male

• Decline to Specify

9


DetailsField

• Other

Typestring

IndividualId__c


DescriptionIdentifier for the individual.

Typepicklist

IndividualType__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionType of individual. Valid values:

• Individual

Typestring




Typestring

PreferredName__c


DescriptionIndividual’s preferred name.

Typepicklist

PrimaryLanguage__c


DescriptionIndividual’s primary language.

Valid values:

• Abkhaz

• Adyghe

• Afrikaans

10


DetailsField

• 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

• Corsican

• Crimean Tatar

• Croatian

• Czech

• Danish

• Dawro

• Dutch

• English

• Esperanto

• Estonian

• Ewe

• Fiji Hindi

• Filipino

• Finnish

• French

11


DetailsField

• 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

• Kinyarwanda

• Korean

• Kurdish/Kurdî

• Ladin

• Latgalian

• Latin

• Lingala

• Livonian

• Lojban

• Low German

• Lower Sorbian

• Macedonian

• Malay

• Malayalam

• Mandarin

12


DetailsField

• 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

• Serbian

• Serbo-Croatian

• Sinhalese

• Slovak

• Slovene

• Spanish

• Swahili

• Swedish

• Tagalog

• Tajik

• Tamil

• Tarantino

• Telugu

• Thai

• Tok Pisin

13


DetailsField

• Turkish

• Twi

• Ukrainian

• Upper Sorbian

• Urdu

• Uzbek

• Venetian

• Vietnamese

• Vilamovian

• Volapük

• Võrro

• Welsh

• Xhosa

• Yiddish

• Zazaki

Typepicklist

SecondaryLanguage__c


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

14


DetailsField

• 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

• Icelandic

• Indonesian

• Interlingua

15


DetailsField

• 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

• Pashto

• Persian

• Pitjantjatjara

16


DetailsField

• 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

• Võrro

• Welsh

• Xhosa

17


DetailsField

• Yiddish

• Zazaki

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Unique, Update


Typestring

SourceSystem__c


DescriptionAn external data source.

Lead Custom FieldsCustom fields extend the standard Lead object for use in Health Cloud to represent information about an incoming patient.

Fields

DetailsField

Typereference

AssignCareCoordinatorContact__c


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


DescriptionLookup to User object. If populated, assigns the care coordinator role based on the user record.

18

Lead Custom FieldsHealth Cloud Developer Guide

DetailsField

Typedate

BirthDate__c


DescriptionThe patient’s birthdate.

Typeboolean

CreatedFromLead__c


DescriptionIndicates whether the individual was created from a converted lead (true) or not (false).

Typeboolean

IsMarkedForPatientConversion__c


DescriptionWhether the lead will be converted to a patient record.

Typestring




Typedouble

NumberofLocations__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionNumber of locations associated with the lead.

Typepicklist

Primary__c


19

Lead Custom FieldsHealth Cloud Developer Guide

DetailsField

DescriptionIndicates whether the individual is the primary member of the household (true) or not(false).

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update


Typestring

SourceSystem__c


DescriptionThe system that created the record and owns updating rights for it.

Task Custom FieldsCustom fields extend the standard Task object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typereference

CarePlanGoal__c


DescriptionRepresents the intended objectives of carrying out a care plan.

Typereference

CarePlanProblem__c


DescriptionRepresents the conditions, problems, concerns, diagnoses, and so on, whose managementand mitigation are handled by this plan.

20

Task Custom FieldsHealth Cloud Developer Guide

DetailsField

Typedouble

SortOrder___c


DescriptionThe order in which the task appears among other tasks associated with a goal.

Typepicklist

TaskType__c


DescriptionThe list of healthcare-related tasks configured in the org.

Electronic Health Record Custom Objects

EhrAllergyIntolerance__cRepresents 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 Lightning Platform.

Typestring

CriticalityCode__c


21

Electronic Health Record Custom ObjectsHealth Cloud Developer Guide

DetailsField

DescriptionThe system-defined code that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalityLabel__c


DescriptionThe human-readable label that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalitySystem__c


DescriptionThe system that defines an estimate of the potential clinical harm or seriousness of thereaction to the identified substance.

Typeboolean

IsRestricted__c


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.

22

EhrAllergyIntolerance__cHealth Cloud Developer Guide

DetailsField

TypedateTime

LastReferencedDate


DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate


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


DescriptionThe patient who has the sensitivity. Lookup to EhrPatient__c.

Typestring

Reaction255__c


DescriptionA description of the allergic reaction, including details of the manifestation if required. Limit:255 characters.

Typetextarea

Reaction__c

PropertiesCreate, Nillable, Update

23


DetailsField

DescriptionA long text description of the allergic reaction, including details of the manifestation ifrequired.

TypedateTime

RecordedDate__c


DescriptionThe date when the sensitivity was recorded.

Typestring

RecorderName255__c


DescriptionThe name of the individual who recorded the record and takes responsibility for its content.Limit: 255 characters.

Typetextarea

RecorderName__c


DescriptionThe long text description of the name of the individual who recorded the record and takesresponsibility for its content.

Typereference

Recorder__c


DescriptionThe individual who takes responsibility for the content and can reference its source. Lookupto EhrPractitioner__c.

Typereference

SensitivityTest1__c


DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.

24


DetailsField

Typereference

SensitivityTest2__c



Typereference

SensitivityTest3__c



Typestring

SensitivityTypeCode__c


DescriptionThe system-defined code that represents the patient’s sensitivity.

Typestring

SensitivityTypeLabel__c


DescriptionThe human-readable label that represents the patient’s sensitivity

Typestring

SensitivityTypeSystem__c


DescriptionThe system that defines the patient’s sensitivity

Typestring

SourceSystem__c


DescriptionA name that identifies the system that created the record and owns update rights to it.

25


DetailsField

Typestring

SourceSystemId__c



TypedateTime

SourceSystemModified__c


DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

StatusCode__c


DescriptionThe system-defined code that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusLabel__c


DescriptionThe human-readable label that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusSystem__c


DescriptionThe system that defines the level of certainty associated with the potential risk of a reactionto the identified substance.

Typestring

Substance255__c


26


DetailsField

DescriptionThe substance or class of substances that’s considered responsible for the adverse reactionrisk. Limit: 255 characters.

Typetextarea

SubstanceLong__c


DescriptionThe long text description of the substance or class of substances that’s considered responsiblefor the adverse reaction risk.

EhrCarePlan__cRepresents 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.


Fields

DetailsField

Typereference

Account__c



Typeboolean

IsRestricted__c



Typeboolean


27

EhrCarePlan__cHealth Cloud Developer Guide

DetailsField



Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR care plan ID. Limit: 255 characters.

Typetextarea

Notes__c


DescriptionNotes about the execution of the activity.

28


DetailsField

Typereference

Patient__c


DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

TypedateTime

PeriodEnd__c


DescriptionThe last date when the plan is in effect.

TypedateTime

PeriodStart__c


DescriptionThe first date when the plan comes (or is intended to come) into effect.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




29


DetailsField

Typestring

Status__c


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.

EhrCarePlanActivity__cRepresents a planned action to occur as part of a care plan. Examples include a medication to be used, lab tests to perform, and education.


Fields

DetailsField

Typetextarea

ActionsResulting__c


DescriptionResources that describe follow-on actions resulting from the care plan, such as drugprescriptions, encounter records, and appointments.

Typestring

ActivityPeriod__c


DescriptionThe period when the described activity is to occur.

30

EhrCarePlanActivity__cHealth Cloud Developer Guide

DetailsField

Typestring

ActivitySchedule__c


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.

Typestring

Category__c


DescriptionA high-level categorization of the type of activity in a care plan.

Typestring

Code__c


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


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

31


DetailsField


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


DescriptionThe quantity expected to be consumed in a given day.

Typetextarea

Details__c


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


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



Typeboolean



32


DetailsField


Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LocationId__c


DescriptionAn external identifier for the facility where the activity will occur. Examples of locationsinclude home, hospital, and specific clinic.

Typestring

LocationLine1__c


DescriptionThe first line in the address of the facility where the activity will occur.

33


DetailsField

Typestring

LocationLine2__c


DescriptionThe second line in the address of the facility where the activity will occur.

Typestring

LocationName__c


DescriptionThe name of the facility where the activity will occur. Examples of locations include home,hospital, and specific clinic.

Typestring

LocationPostalCode__c


DescriptionThe postal code in the address of the facility where the activity will occur.

TypedateTime

LocationStartDate__c


DescriptionThe first date when a location is valid as the facility where the activity will occur.

Typestring

LocationState__c


DescriptionThe state in the address of the facility where the activity will occur.

Typestring

LocationTelecom__c


34


DetailsField

DescriptionA contact detail for the facility where the activity will occur.

Typetextarea

LocationText__c


DescriptionThe complete address of the facility where the activity will occur.

Typestring

LocationType__c


DescriptionThe type of location where the activity will occur.

Typestring

LocationUse__c


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


DescriptionNotes about the execution of the activity.

Typestring

ProductMedication255__c


35


DetailsField

DescriptionThe drug to be consumed or supplied in the activity. Limit: 255 characters.

Typetextarea

ProductMedication__c


DescriptionThe long text description of the drug to be consumed or supplied in the activity.

Typestring

ProductSubstance255__c


DescriptionA homogeneous material with a definite composition. Limit: 255 characters.

Typetextarea

ProductSubstance__c


DescriptionThe long text description of a homogeneous material with a definite composition.

Typestring

Quantity__c


DescriptionThe quantity expected to be supplied, administered, or consumed.

Typereference

RelatedCarePlanGoal1__c


DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference



36


DetailsField


Typereference




Typereference




Typereference




Typereference

RelatedEncounter__c


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


DescriptionA related order for supply of a medication and the instructions for administration of themedicine to a patient. Lookup to EhrMedicationPrescription__c.

37


DetailsField

Typestring

SourceSystem__c



TypedateTime




Typestring

Status__c


DescriptionAn indicator of the progress being made by the specific activity.

Typestring

TypeCode__c


DescriptionThe system-defined code that represents the type of activity in a care plan.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the type of activity in a care plan.

Typestring

TypeSystem__c


DescriptionThe system that defines the type of activity in a care plan.

38


EhrCarePlanConcern__cRepresents 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



Typereference

CarePlanGoal__c


DescriptionThe intended objectives of carrying out the care plan.

Typereference

Condition__c


DescriptionThe problems and diagnoses recognized by a clinician. Lookup to EhrCondition__c.

Typeboolean

IsRestricted__c



Typeboolean


39

EhrCarePlanConcern__cHealth Cloud Developer Guide

DetailsField



Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR care plan concern ID. Limit: 255 characters.

Typestring

SourceSystem__c



TypedateTime




EhrCarePlanGoal__cRepresents the intended objectives of carrying out the care plan.

40

EhrCarePlanGoal__cHealth Cloud Developer Guide


Fields

DetailsField

Typereference

CarePlan__c



Typetextarea

Description__c


DescriptionA description of the care plan goal.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate



41


DetailsField



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR care plan goal ID. Limit: 255 characters.

Typetextarea

Notes__c


DescriptionComments about the care plan goal.

Typestring

SourceSystem__c



TypedateTime



42


DetailsField


Typestring

Status__c


DescriptionWhether the plan is currently being acted upon, represents future intentions, or is onlyhistorical record.

EhrCarePlanParticipant__cRepresents people and organizations who are expected to be involved in the care envisioned by a care plan.


Fields

DetailsField

Typereference

CarePlan__c



Typereference

CarePlanActivity__c


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

43

EhrCarePlanParticipant__cHealth Cloud Developer Guide

DetailsField



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR care plan participant ID. Limit: 255 characters.

44


DetailsField

Typereference

Patient__c


DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

Typestring

Practitioner255__c


DescriptionA person who’s involved in the providing of healthcare. Limit: 255 characters.

Typereference

Practitioner__c


DescriptionA person who’s involved in the providing of healthcare. Lookup to EhrPractitioner__c.

Typetextarea

PractitionerName__c


DescriptionThe long text description of the name of a person who’s involved in the providing ofhealthcare.

Typereference

RelatedPerson__c


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


45


DetailsField

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.

Typestring

RoleLabel__c


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


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



Typestring

SourceSystemId__c



TypedateTime




46


EhrCondition__cRepresents detailed information about conditions, problems, and diagnoses recognized by a clinician.


Fields

DetailsField

Typestring

AbatementDetail255__c


DescriptionThe date or estimated date when the condition was resolved or went into remission. Limit:255 characters.

Typestring

AbatementDetail__c


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,


Typestring

AsserterPatient__c


DescriptionThe person who asserts the condition.

Typestring

AsserterPractitioner__c

47

EhrCondition__cHealth Cloud Developer Guide

DetailsField


DescriptionThe person reporting the condition.

Typestring

CategoryCode__c


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


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


DescriptionThe system that defines the category that’s assigned to the condition. Examples of categoriesare complaint, symptom, and diagnosis.

Typestring

CertaintyCode__c


DescriptionThe system-defined code that represents level of confidence that the condition is correct.

Typestring

CertaintyLabel__c


DescriptionThe human-readable label that represents the certainty of a correct condition.

48


DetailsField

Typestring

CertaintySystem__c


DescriptionThe system that defines the certainty.

Typestring

Code__c


DescriptionThe system-defined code that represents the condition, problem, or diagnosis.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents the condition, problem, or diagnosis.

Typestring

CodeSystem__c


DescriptionThe system that defines the condition, problem, or diagnosis.

TypedateTime

DateAsserted__c


DescriptionThe estimated or actual date when the condition, problem, or diagnosis was first detectedor suspected.

Typereference

Encounter__c


49


DetailsField

DescriptionThe encounter during which the condition was first asserted. Lookup to EhrEncounter__c.

Typestring

EvidenceCode__c


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


DescriptionA long text description of supporting information such as pathology reports.

Typestring

EvidenceLabel__c


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


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


50


DetailsField

DescriptionWhether the condition is resolved or in remission (true) or not (false). The defaultcheckbox value is deselected.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



51


DetailsField

Typestring

LocationCode__c


DescriptionThe system-defined code that represents the anatomical location where the condition ismanifested.

Typetextarea

LocationDetail__c


DescriptionA long text description with precise details about the anatomical location where the conditionis manifested.

Typestring

LocationLabel__c


DescriptionThe human-readable label that represents the anatomical location where the condition ismanifested.

Typestring

LocationSystem__c


DescriptionThe system that defines the anatomical location where the condition is manifested.

Typestring

Name


DescriptionThe EHR condition ID. Limit: 255 characters.

Typetextarea

Notes__c


52


DetailsField

DescriptionAdditional information about the condition, including general comments about thedescription of the condition, its diagnosis, and prognosis.

Typestring

Onset__c


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


DescriptionThe patient’s name. Lookup to EhrPatient__c.

Typestring

SeverityCode__c


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


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


53


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



Typestring

SourceSystemId__c



TypedateTime




Typestring

Stage__c


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


DescriptionThe system-defined code that represents the condition’s clinical status.

54


DetailsField

Typestring

StatusLabel__c


DescriptionThe human-readable label that represents the condition’s clinical status.

Typestring

StatusSystem__c


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__cRepresents an item that’s related to a patient’s conditions, problems, or diagnoses recognized by a clinician.


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents the item related to the patient’s condition.

Typestring

CodeLabel__c

55

EhrConditionRelatedItem__cHealth Cloud Developer Guide

DetailsField


DescriptionThe human-readable label that represents the item related to the patient’s condition.

Typestring

CodeSystem__c


DescriptionThe system that defines the item related to the patient’s condition.

Typereference

Condition__c


DescriptionThe patient’s problem or diagnosis recognized by a clinician.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





56


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedicationStatement__c


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


DescriptionAdditional information about the item related to the patient’s condition.

Typestring

SourceSystem__c


57


DetailsField


TypedateTime




Typestring

TargetCondition__c


DescriptionLookup to EhrCondition__c.

Typetextarea

TargetDetail__c


Description

Typereference

TargetImmunization__c


DescriptionLookup to EhrImmunization__c.

EhrDevice__cRepresents 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.


58

EhrDevice__cHealth Cloud Developer Guide

Fields

DetailsField

Typetextarea

Contact__c


DescriptionA long text description of the contact details for an organization or person who’s responsiblefor support for the device.

Typetextarea

DeviceURL__c


DescriptionA long text description of the network address on which the device can be directly contacted.

Typedate

Expiry__c


DescriptionThe date and time after which this device is not valid or should not be used.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate


59


DetailsField




TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Location255__c


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


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


DescriptionA lot number assigned by the manufacturer.

60


DetailsField

Typestring

Manufacturer__c


DescriptionThe name of the device’s manufacturer.

Typestring

Model__c


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


DescriptionThe EHR device ID. Limit: 255 characters.

Typestring

Owner255__c


DescriptionThe organization that’s responsible for the provision and maintenance of the device. Limit:255 characters.

Typetextarea

Owner__c


DescriptionThe long text description of the organization that’s responsible for the provision andmaintenance of the device.

Typereference

OwnerId


61


DetailsField

Description

Typereference

Patient__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

Type__c


DescriptionThe type of device.

Typestring

Udi__c


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.

62


DetailsField

Typestring

Version__c


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__cRepresents instructions for how a medication is to be used by a patient.


Fields

DetailsField

Typestring

AdditionalInstruction__c


DescriptionAdditional dosage instructions such as “Take with food.”

Typestring

AdditionalInstructionCode__c


DescriptionThe system-defined code that represents additional dosage instructions.

Typestring

AdditionalInstructionLabel__c

63

EhrDosageInstruction__cHealth Cloud Developer Guide

DetailsField


DescriptionThe human-readable label that represents additional dosage instructions.

Typestring

AdditionalInstructionSystem__c


DescriptionThe system that defines additional dosage instructions.

Typeboolean

AsNeeded__c


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


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


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


64


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


DescriptionThe unit of measurement in the amount of medication that was dispensed.

Typestring

DoseQuantityValue__c


DescriptionThe amount of medication that was dispensed.

Typereference

EhrPatient__c


DescriptionThe individual receiving healthcare services.

Typetextarea

Instruction__c


DescriptionA long text description of how a medication is to be used by a patient.

Typeboolean

IsRestricted__c



Typeboolean


65


DetailsField



Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MaxDosePerPeriodAmountUnit__c


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


66


DetailsField

DescriptionThe maximum total quantity of a therapeutic substance that can be administered to a subjectover a period of time.

Typestring

MaxDosePerPeriodDenominatorUnit__c


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


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


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


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


67


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


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


DescriptionAn order for supply of a medication and the instructions for administration of the medicineto a patient. Lookup to EhrMedicationPrescription__c.

Typereference

MedicationStatement__c


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


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


68


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


DescriptionThe system that defines the method by which a medication is introduced into or onto thebody, most commonly used for injections.

Typestring

Name


DescriptionThe EHR dosage instruction ID. Limit: 255 characters.

Typestring

RateDenominator__c


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


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


DescriptionThe system-defined code that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

69


DetailsField

Typestring

RouteLabel__c


DescriptionThe human-readable label that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

Typestring

RouteSystem__c


DescriptionThe system that defines the route or physiological path of administration of a therapeuticagent into or onto a subject.

Typestring

SiteCode__c


DescriptionThe system-defined code that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteLabel__c


DescriptionThe human-readable label that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteSystem__c


DescriptionThe system that defines the anatomic site where the medication first enters the body.

Typestring

SourceSystem__c

70


DetailsField



TypedateTime




Typetextarea

SupplementalInstructions__c


DescriptionAny additional instructions.

TypedateTime

TimingPeriod__c


DescriptionThe defined period of time.

TypedateTime

TimingPeriodEnd__c


DescriptionThe last day of the time period.

TypedateTime

TimingPeriodStart__c


DescriptionThe first day of the time period.

71


EhrEncounter__cRepresents 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.


Fields

DetailsField

Typereference

Account__c



Typestring

Class__c


DescriptionThe classification of the encounter. Examples include inpatient, outpatient, ambulatory, andemergency.

Typereference

Encounter__c


DescriptionThe name of the interaction during which services are provided to the patient. Lookup toEhrEncounter__c.

Typestring

HospitalizeAdmitSourceCode__c


DescriptionThe system-defined code that represents the source from which the patient was admitted.Examples of sources include physician referral and transfer.

72

EhrEncounter__cHealth Cloud Developer Guide

DetailsField

Typestring

HospitalAdmitSourceLabel__c


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


DescriptionThe system that defines the source from which the patient was admitted. Examples of sourcesinclude physician referral and transfer.

Typestring

HospitalizeDestination__c


DescriptionThe location to which the patient is discharged.

Typestring

HospitalizeDietCode__c


DescriptionThe system-defined code that represents diet preferences that the patient reports.

Typestring

HospitalizeDietLabel__c


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

73


DetailsField


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


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


DescriptionThe system-defined code that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionLabel__c


DescriptionThe human-readable label that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionSystem__c


DescriptionThe system that defines the category or kind of patient location after discharge.

Typetextarea

HospitalizeOrigin__c


74


DetailsField

DescriptionThe location from which the patient came before admission.

TypedateTime

HospitalizePeriodEnd__c


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


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


DescriptionAn identifier for hospitalization pre-admission.

Typeboolean

HospitalizeReadmission__c


DescriptionWhether this hospitalization is a readmission (true) or not (false). The default checkboxvalue is deselected.

Typestring

HospitalizeSpecialArrangementCode__c


DescriptionThe system-defined code that represents special arrangements such as a wheelchair,translator, or stretcher.

75


DetailsField

Typestring

HospitalizeSpecialArrangementLabel__c


DescriptionThe human-readable label that represents special arrangements such as a wheelchair,translator, or stretcher.

Typestring

HospitalizeSpecialArrangementSystem__c


DescriptionThe system that defines special arrangements such as a wheelchair, translator, or stretcher.

Typestring

HospitalizeSpecialCourtesyCode__c


DescriptionThe system-defined code that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesyLabel__c


DescriptionThe human-readable label that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesySystem__c


DescriptionThe system that defines a special courtesy such as a courtesy that’s extended to a boardmember or VIP.

Typetextarea

HospitalizationOrigin__c

76


DetailsField


DescriptionThe location from which the patient came before admission.

Typestring

HospitalizationPreAdmissionId__c


DescriptionAn identifier for hospitalization pre-admission.

Typestring

Indication__c


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



Typeboolean




Typedate

LastActivityDate



77


DetailsField



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LengthUnit__c


DescriptionA unit of measurement of time that the encounter lasted, excluding the time during leavesof absence.

Typestring

LengthValue__c


DescriptionThe length of time that the encounter lasted, excluding the time during leaves of absence.

Typestring

Location1City__c


DescriptionThe city where a patient encounter occurs.

Typestring

Location1Country__c

78


DetailsField


DescriptionThe country where a patient encounter occurs.

Typestring

Location1Description__c


DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location1EndDate__c


DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location1Id__c


DescriptionAn external identifier for the location where a patient encounter occurs.

Typestring

Location1Line1__c


DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location1Line2__c


DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location1Name__c

79


DetailsField


DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location1PostalCode__c


DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location1StartDate__c


DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location1State__c


DescriptionThe state in the address of the location where a patient encounter occurs.

TypedateTime

Location1TelecomPeriodEnd__c


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


80


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


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


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


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


DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location1TypeCode__c


81


DetailsField

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeLabel__c


DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeSystem__c


DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location1Type__c


DescriptionThe type of location where the patient encounter occurs.

Typestring

Location1Use__c


DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location2City__c



Typestring

Location2Country__c

82


DetailsField



Typestring




TypedateTime

Location2EndDate__c



Typestring

Location2Id__c



Typestring

Location2Line1__c



Typestring

Location2Line2__c



Typestring

Location2Name__c

83


DetailsField



Typestring




TypedateTime




Typestring

Location2State__c



TypedateTime




TypedateTime



84


DetailsField


Typestring




Typestring




Typestring




Typetextarea

Location2Text__c



Typestring



85


DetailsField


Typestring




Typestring




Typestring

Location2Type__c



Typestring

Location2Use__c



Typestring

Location3City__c



Typestring

Location3Country__c

86


DetailsField



Typestring




TypedateTime

Location3EndDate__c



Typestring

Location3Id__c



Typestring

Location3Line1__c



Typestring

Location3Line2__c



Typestring

Location3Name__c

87


DetailsField



Typestring




TypedateTime




Typestring

Location3State__c



TypedateTime




TypedateTime



88


DetailsField


Typestring




Typestring




Typestring




Typetextarea

Location3Text__c



Typestring



89


DetailsField


Typestring




Typestring




Typestring

Location3Type__c



Typestring

Location3Use__c



Typestring

Location4City__c



Typestring

Location4Country__c

90


DetailsField



Typestring




TypedateTime

Location4EndDate__c



Typestring

Location4Id__c



Typestring

Location4Line1__c



Typestring

Location4Line2__c



Typestring

Location4Name__c

91


DetailsField



Typestring




TypedateTime




Typestring

Location4State__c



TypedateTime




TypedateTime



92


DetailsField


Typestring




Typestring




Typestring




Typetextarea

Location4Text__c



Typestring



93


DetailsField


Typestring




Typestring




Typestring

Location4Type__c



Typestring

Location4Use__c



Typestring

Location5City__c



Typestring

Location5Country__c

94


DetailsField



Typestring




TypedateTime

Location5EndDate__c



Typestring

Location5Id__c



Typestring

Location5Line1__c



Typestring

Location5Line2__c



Typestring

Location5Name__c

95


DetailsField



Typestring




TypedateTime




Typestring

Location5State__c



TypedateTime




TypedateTime



96


DetailsField


Typestring




Typestring




Typestring




Typetextarea

Location5Text__c



Typestring



97


DetailsField


Typestring




Typestring




Typestring

Location5Type__c



Typestring

Location5Use__c



Typestring

Name


DescriptionThe EHR encounter ID. Limit: 255 characters.

Typereference

Patient__c

98


DetailsField



TypedateTime

PeriodEnd__c


DescriptionThe last date and time when the period is valid for this patient encounter.

TypedateTime

PeriodStart__c


DescriptionThe first date and time when the period is valid for this patient encounter.

Typestring

PriorityCode__c


DescriptionThe system-defined code that represents the urgency of the patient encounter.

Typestring

PriorityLabel__c


DescriptionThe human-readable label that represents the urgency of the patient encounter.

Typestring

PrioritySystem__c


DescriptionThe system that defines the urgency of the patient encounter.

Typestring

Priority__c

99


DetailsField


DescriptionAn indication of the urgency of the patient encounter. Examples include immediate,emergency, urgent, semi-urgent, and non-urgent.

Typestring

ReasonCode__c


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


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


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


DescriptionAn indication of the status of the patient encounter. Examples include planned, arrived,in-progress, onleave, finished, and cancelled.

Typestring

TypeCode__c


100


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


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


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__cRepresents the type of accommodation received by the patient during an encounter.


Fields

DetailsField

Typestring

Bed__c

101

EhrEncounterAccommodation__cHealth Cloud Developer Guide

DetailsField


DescriptionAn indicator for the type of bed that the patient uses during the encounter.

Typereference

Encounter__c


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



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate


102

EhrEncounterAccommodation__cHealth Cloud Developer Guide

DetailsField


TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR encounter accommodation ID. Limit: 255 characters.

Typestring

Period__c


DescriptionThe time period when the accommodation type is valid.

Typestring

SourceSystem__c



TypedateTime




EhrEncounterParticipant__cRepresents a person, other than the patient, who’s involved in the patient encounter.

103

EhrEncounterParticipant__cHealth Cloud Developer Guide


Fields

DetailsField

Typereference

Encounter__c


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


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



Typeboolean




Typedate

LastActivityDate


104


DetailsField




TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR encounter participant ID. Limit: 255 characters.

Typereference

Practitioner__c


DescriptionA person who’s involved in the providing of healthcare services. Lookup to EhrPractitioner__c.

Typereference

RelatedPerson__c


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.

105


DetailsField

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typedate

StartDate__c


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


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.

Typestring

TypeLabel__c

106


DetailsField


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


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__cRepresents 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


DescriptionThe individual account that represents the patient in Lightning Platform

TypedateTime

DateAdministered__c


107

EhrImmunization__cHealth Cloud Developer Guide

DetailsField

DescriptionThe date when a vaccine was administered or was to be administered.

Typestring

DoseQuantity__c


DescriptionThe quantity of vaccine product that was administered.

Typestring

DoseQuantityUnits__c


DescriptionThe unit of measurement in the quantity of vaccine product that was administered.

Typestring

DoseQuantityValue__c


DescriptionThe quantity of vaccine product that was administered.

TypedateTime

ExpirationDate__c


DescriptionThe date when a vaccine batch expires.

Typeboolean

IsRestricted__c



Typeboolean



108


DetailsField


Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LocationCity__c


DescriptionThe city where the vaccine was administered.

Typestring

LocationCountry__c


DescriptionThe country where the vaccine was administered.

109


DetailsField

Typestring

LocationId__c


DescriptionAn external identifier for the service delivery location where the vaccine was administered.

Typestring

LocationLline1__c


DescriptionThe first line of the address where the vaccine was administered.

Typestring

LocationLline2__c


DescriptionThe second line of the address where the vaccine was administered.

Typestring

LocationName__c


DescriptionThe name of the location where the vaccine was administered.

Typestring

LocationPostalCode__c


DescriptionThe postal code in the address where the vaccine was administered.

TypedateTime

LocationStartDate__c


DescriptionThe first date when the vaccination location is valid.

110


DetailsField

Typestring

LocationState__c


DescriptionThe state where the vaccine was administered.

Typestring

LocationTelecom__c


DescriptionA contact detail for the location where the vaccine was administered.

Typetextarea

LocationText__c


DescriptionThe complete address of the location where the vaccine was administered.

Typestring

LocationType__c


DescriptionA type of location where the vaccine was administered.

Typestring

LocationUse__c


DescriptionDetails such as home or office related to the location where the vaccine was administered.

Typestring

LotNumber__c


DescriptionThe lot number of the vaccine product that was administered.

111


DetailsField

Typestring

Name


DescriptionThe name of the vaccine product that was administered. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe patient who received or was to receive the vaccine. Lookup to EhrPatient__c.

Typereference

Performer__c


DescriptionThe clinician who administered the vaccine. Lookup to EhrPractitioner__c.

Typestring

PerformerName255__c


DescriptionThe clinician who administered the vaccine. Limit: 255 characters.

Typetextarea

PerformerName__c


DescriptionThe long text description of the name of the clinician who administered the vaccine.

Typestring

ReasonCode__c


DescriptionThe system-defined code that represents the reason why a vaccination was administered.

112


DetailsField

Typestring

ReasonLabel__c


DescriptionThe human-readable label that represents the reason why a vaccination was administered.

Typestring

ReasonSystem__c


DescriptionThe system that defines the reason why a vaccination was administered.

Typestring

RefusalLabel__c


DescriptionThe human-readable label that indicates that the vaccine wasn’t administered.

Typestring

RefusalReasonCode__c


DescriptionThe system-defined code that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonLabel__c


DescriptionThe human-readable label that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonSystem__c


DescriptionThe system that defines the reason why a vaccine wasn’t administrated.

113


DetailsField

Typeboolean

RefusedIndicator__c


DescriptionWhether the vaccine was refused (true) or not (false). The default checkbox value isdeselected.

Typereference

Requestor__c


DescriptionThe clinician who ordered the vaccine. Lookup to EhrPractitioner__c.

Typestring

RequestorName255__c


DescriptionThe clinician who ordered the vaccine. Limit: 255 characters.

Typetextarea

RequestorName__c


DescriptionThe long text description of the name of the clinician who ordered the vaccine.

Typestring

RouteCode__c


DescriptionThe system-defined code that represents the path through which the vaccine is taken intothe body.

Typestring

RouteLabel__c


114


DetailsField

DescriptionThe human-readable label that represents the path through which the vaccine is taken intothe body.

Typestring

RouteSystem__c


DescriptionThe system that defines the path through which the vaccine is taken into the body.

Typeboolean

SelfReported__c


DescriptionWhether the vaccine is self-reported (true) or not (false). The default checkbox valueis deselected.

Typestring

SiteCode__c


DescriptionThe system-defined code that represents the body site where the vaccine was administered.

Typestring

SiteLabel__c


DescriptionThe human-readable label that represents the body site where the vaccine was administered.

Typestring

SiteSystem__c


DescriptionThe system that defines the body site where the vaccine was administered.

Typestring

SourceSystem__c

115


DetailsField



Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort, Update


TypedateTime




Typestring

VaccineTypeCode__c


DescriptionThe system-defined code that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeLabel__c


DescriptionThe human-readable label that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeSystem__c


DescriptionThe system that defines the type of vaccine that was administered or was to be administered.

116


UsageThis resource excludes the administration of nonvaccine agents, even those that have or claim to have immunological effects.

EhrImmunizationReaction__cRepresents categorical data indicating that an adverse event is associated in time with an immunization.


Fields

DetailsField

Typereference

Account__c



Typetextarea

Details__c


DescriptionAdditional information about the reaction.

Typereference

EhrObservation__c


DescriptionMeasurements and assertions made regarding a patient or device. Lookup toEhrObservation__c.

Typereference

Immunization__c


DescriptionInformation about the administration of vaccines to patients. Lookup to EhrImmunization__c.

117

EhrImmunizationReaction__cHealth Cloud Developer Guide

DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


118


DetailsField

DescriptionThe EHR immunization reaction ID. Limit: 255 characters.

Typestring

Reaction255__c


DescriptionDetails about a reaction that follows an immunization. Limit: 255 characters.

Typetextarea

Reaction__c


DescriptionThe long text description of a reaction that follows an immunization.

TypedateTime

ReactionStartDate__c


DescriptionThe date when the reaction to the immunization first occurred.

Typeboolean

SelfReported__c


DescriptionWhether the reaction was self-reported (true) or not (false). The default checkbox valueis deselected.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c

119


DetailsField



TypedateTime




EhrMedicationPrescription__cRepresents an order for supply of a medication and the instructions for administration of the medicine to a patient.


Fields

DetailsField

Typereference

Account__c



TypedateTime

DateWritten__c


DescriptionThe date (and optionally time) when the prescription was written.

Typedouble

DispenseExpectedSupplyDuration__c

120

EhrMedicationPrescription__cHealth Cloud Developer Guide

DetailsField


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


DescriptionThe system-defined code that identifies the medication being administered.

Typestring

DispenseMedicationCodeSystem__c


DescriptionThe system that defines the code that identifies this medication.

TypedateTime

DispenseMedicationExpiration__c


DescriptionThe date when a specific batch of product expires.

Typeboolean

DispenseMedicationIsBrand__c


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.

121


DetailsField

Typestring

DispenseMedicationKindCode__c


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


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


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


DescriptionThe human-readable label that identifies and defines a medication.

Typestring

DispenseMedicationLotNumber__c


DescriptionThe assigned lot number of a batch of the specified product.

Typestring

DispenseMedicationName__c


122


DetailsField

DescriptionA common commercial name for the medication.

Typestring

DispenseMedicationProductFormCode__c


DescriptionThe system-defined code that represents the form of the product: powder, tablet, or carton+ code.

Typestring

DispenseMedicationProductFormLabel__c


DescriptionThe human-readable label that represents the form of the product: powder, tablet, or carton+ human-readable label.

Typestring

DispenseMedicationProductFormSystem__c


DescriptionThe system that defines the form of the product: powder, tablet, or carton + system.

Typedouble

DispenseNumberOfRepeatedAllowed__c


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


DescriptionA unit of measurement in the amount to be dispensed for one fill.

123


DetailsField

Typedouble

DispenseQuantityValue__c


DescriptionThe amount of medication to supply per dispense.

TypedateTime

DispenseValidityPeriodEnd__c


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


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


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.

Typeboolean

IsRestricted__c



Typeboolean


124


DetailsField



Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MedicationCode__c


DescriptionThe system-defined code that identifies a medication.

Typestring

MedicationCodeLabel__c


DescriptionThe human-readable label that identifies a medication.

125


DetailsField

Typestring

MedicationCodeSystem__c


DescriptionThe system that defines a medication.

TypedateTime

MedicationExpiration__c



Typeboolean

MedicationIsBrand__c



Note: The manufacturer doesn’t have to be known.

Typestring

MedicationKindCode__c



Typestring

MedicationKindLabel__c



Typestring

MedicationKindSystem__c

126


DetailsField



Typestring

MedicationLotNumber__c



Typestring

MedicationName__c



Typestring

MedicationProductFormCode__c


DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

Typestring

MedicationProductFormLabel__c


DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring

MedicationProductFormSystem__c


DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

127


DetailsField

Typestring

Name


DescriptionThe EHR medication prescription ID. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe person to whom a medication will be given. Lookup to EhrPatient__c.

Typereference

Prescriber__c


DescriptionThe healthcare professional who’s responsible for authorizing the prescription. Lookup toEhrPractitioner__c.

Typestring

PrescriberName__c


DescriptionThe long text description of the name of the healthcare professional who’s responsible forauthorizing the prescription.

Typestring

ReasonCode__c


DescriptionThe system-defined code that represents the reason or indication for writing the prescription.

Typereference

ReasonCondition__c


128


DetailsField

DescriptionLookup to EhrCondition__c.

Typestring

ReasonLabel__c


DescriptionThe human-readable label that represents the reason or indication for writing the prescription.

Typestring

ReasonSystem__c


DescriptionThe system that defines the reason or indication for writing the prescription.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

StatusCode__c


129


DetailsField

DescriptionThe code that specifies the state of the order, typically active or completed.

Typestring

StatusLabel__c


DescriptionThe human-readable label that specifies the state of the order, typically active or completed.

Typestring

StatusSystem__c


DescriptionThe system that defines the state of the order, typically active or completed.

Typetextarea

SubstituteRestrictReasonCode__c


DescriptionThe system-defined code that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonLabel__c


DescriptionThe human-readable label that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonSystem__c


DescriptionThe system that defines the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictTypeCode__c


130


DetailsField

DescriptionThe system-defined code that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeLabel__c


DescriptionThe human-readable label that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeSystem__c


DescriptionThe system that defines whether a different drug can be dispensed from what was prescribed.

EhrMedicationStatement__cRepresents 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.


Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient in Lightning Platform

Typereference

Device__c

131

EhrMedicationStatement__cHealth Cloud Developer Guide

DetailsField


DescriptionA manufactured item that’s used in the providing of healthcare without being substantiallychanged through that activity. Lookup to EhrDevice__c.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


132


DetailsField


Typestring

MedicationCode__c


DescriptionThe system-defined code that identifies a medication.

Typestring

MedicationCodeLabel__c


DescriptionThe human-readable label that identifies a medication.

Typestring

MedicationCodeSystem__c


DescriptionThe system that defines a medication.

TypedateTime

MedicationExpiration__c



Typeboolean

MedicationIsBrand__c



Note: The manufacturer doesn’t have to be known.

133


DetailsField

Typestring

MedicationKindCode__c



Typestring

MedicationKindLabel__c



Typestring

MedicationKindSystem__c



Typestring

MedicationLotNumber__c



Typestring

MedicationName__c



Typestring

MedicationProductFormCode__c


134


DetailsField

DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

Typestring

MedicationProductFormLabel__c


DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring

MedicationProductFormSystem__c


DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

Typestring

Name


DescriptionThe EHR medication statement ID. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe person who’s taking the medication. Lookup to EhrPatient__c.

Typestring

ReasonNotGivenCode__c


DescriptionThe system-defined code that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenLabel__c

135


DetailsField


DescriptionThe human-readable label that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenSystem__c


DescriptionThe system that indicates why the medication wasn’t taken.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typeboolean

WasNotGiven__c


DescriptionWhether the medication wasn’t taken (true) or was taken (false). The default checkboxvalue is deselected.

136


DetailsField

TypedateTime

WhenGiven__c


DescriptionThe date when the medication was taken.

EhrObservation__cRepresents 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.


Fields

DetailsField

Typereference

Account__c



TypedateTime

AppliesDateTime__c


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


137

EhrObservation__cHealth Cloud Developer Guide

DetailsField

DescriptionThe last day when the observed value is asserted as being true.

TypedateTime

AppliesPeriodStartDate__c


DescriptionThe first day when the observed value is asserted as being true.

Typestring

BodySiteCode__c


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


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


DescriptionThe system that defines the site on the patient’s body where the observation was made (alsocalled the target site).

Typetextarea

Comments__c


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.

138


DetailsField

Typereference

Device__c


DescriptionThe device that’s used to generate the observation data. Lookup to EhrDevice__c.

Typestring

InterpretationCode__c


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


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


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



139


DetailsField

TypedateTime

IssuedDate__c


DescriptionThe date and time when the observation was made available. Updated when the result isupdated.

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MethodCode__c

140


DetailsField


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


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


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


DescriptionThe EHR observation ID. Limit: 255 characters.

Typestring

NameCode__c


DescriptionThe system-defined code that represents the name of the observation.

Typestring

NameLabel__c

141


DetailsField


DescriptionThe human-readable label that represents the name of the observation.

Typestring

NameSystem__c


DescriptionThe system that defines the name of the observation.

Typereference

Patient__c


DescriptionThe patient’s name. Lookup to Ehr_Patient__c.

Typereference

Practitioner__c


DescriptionA person with a formal responsibility in the providing of healthcare services. Lookup toEhrPractitioner__c.

Typestring

ReferenceMeaningLabel__c


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


142


DetailsField

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


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


DescriptionThe unit of measurement in the applicable reference range.

Typestring

ReferenceRangeHighValue__c


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 “<”.

Typestring

ReferenceRangeLowUnit__c


DescriptionThe unit of measurement in the applicable reference range.

Typestring

ReferenceRangeLowValue__c


143


DetailsField

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


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


DescriptionThe system that defines the meaning of the applicable reference range.

Typestring

ReferenceRangeUnit__c


DescriptionA unit of measurement within the applicable reference range.

Typepicklist

Reliability__c


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


144


DetailsField

DescriptionThe system-defined code that represents the estimate of the degree to which quality issueshave impacted the reported value.

Typestring

SampledData__c


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



Typestring

SourceSystemId__c



TypedateTime




Typepicklist

Status__c


DescriptionThe status of the observation’s result value. Picklist values: amended, final, preliminary, andregistered.

145


DetailsField

Typestring

StatusCode__c


DescriptionThe system-defined code that represents the status of the observation’s result value.

Typestring

ValueAttachment__c


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


DescriptionThe system-defined code that represents the information determined by making theobservation, if the information has a simple value.

Typestring

ValueLabel__c


DescriptionThe human-readable label that represents the information determined by making theobservation, if the information has a simple value.

Typestring

ValuePeriod__c


DescriptionThe period during which the observed value is valid.

TypedateTime

ValuePeriodEndDate__c


146


DetailsField

DescriptionThe last date when the observed value is valid.

TypedateTime

ValuePeriodStartDate__c


DescriptionThe first date when the observed value is valid.

Typestring

ValueQuantity__c


DescriptionA measured or potentially measurable amount related to the observed value.

Typestring

ValueQuantityUnit__c


DescriptionA unit of measurement related to the observed value.

Typestring

ValueRatio__c


DescriptionA relationship between two quantities, expressed as a numerator and a denominator, relatedto the observed value.

Typestring

ValueRatioDenominator__c


DescriptionThe denominator in the relationship between two quantities related to the observed value.

Typestring

ValueRatioNumerator__c

147


DetailsField


DescriptionThe numerator in the relationship between two quantities related to the observed value.

Typetextarea

ValueSampledData__c


DescriptionData that comes from a series of measurements taken by a device, related to the observedvalue.

Typestring

ValueSampledDataDimensions__c


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


DescriptionA correction factor that’s applied to the sampled data points before they’re added to theorigin.

Typestring

ValueSampledDataLowerLimit__c


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


148


DetailsField

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


DescriptionThe system-defined code that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeLabel__c


DescriptionThe human-readable label that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeSystem__c


DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginComparator__c


DescriptionA comparator used with the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginSystem__c


149


DetailsField

DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginUnits__c


DescriptionUnits of measurement in the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginValue__c


DescriptionThe human-readable value used in the base quantity that a measured value of zero representsin the sampled data.

Typestring

ValueSampledDataPeriodMili__c


DescriptionA time period defined by a start and end date and optionally time, related to the sampleddata.

Typestring

ValueSampledDataUpperLimit__c


DescriptionThe upper limit in data that comes from a series of measurements taken by a device.

Typestring

ValueSystem__c


DescriptionThe system that defines the information determined by making the observation, if theinformation has a simple value.

150


UsageMost observations are simple name-value pair assertions with some metadata, but some observations group other observations togetherlogically, or even are multicomponent observations.

EhrPatient__cRepresents the demographics and other administrative information about a patient who’s receiving health-related services.


Fields

DetailsField

Typereference

Account__c



Typestring

Address1City__c


DescriptionThe city in an address for the patient.

Typestring

Address1Country__c


DescriptionThe country in an address for the patient.

TypedateTime

Address1EndDate__c


DescriptionThe last date when an address for the patient is valid.

151

EhrPatient__cHealth Cloud Developer Guide

DetailsField

Typestring

Address1Line1__c


DescriptionThe first line of a street address for the patient.

Typestring

Address1Line2__c


DescriptionThe second line of a street address for the patient.

Typestring

Address1PostalCode__c


DescriptionThe postal code of an address for the patient.

TypedateTime

Address1StartDate__c


DescriptionThe first date when an address for the patient is valid.

Typestring

Address1State__c


DescriptionThe state in an address for the patient.

Typetextarea

Address1Text__c


DescriptionA complete address for the patient.

152


DetailsField

Typestring

Address1Use__c


DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



153


DetailsField

Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



154


DetailsField

Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




155


DetailsField

Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



156


DetailsField

Typestring

Address4Line1__c



Typestring

Address4Line2__c



Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



157


DetailsField

Typestring

Address4Use__c



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



158


DetailsField

Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



TypedateTime

BirthDate__c


DescriptionThe patient’s birth date.

159


DetailsField

Typestring

Communication1Code__c


DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication1Label__c


DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication1System__c


DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring




Typestring




Typestring


160


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



161


DetailsField


Typestring




Typestring




Typestring




Typestring




Typeboolean

Deceased__c


162


DetailsField

DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.

Typestring

FamilyName1__c


DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c


DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).

Typestring

FamilyName3__c


DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).

Typestring

GenderCode__c


DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderLabel__c


DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

163


DetailsField

Typestring

GenderSystem__c


DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.

Typestring

GivenName1__c


DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName2__c


DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c


DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName4__c


DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c


164


DetailsField

DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typeboolean

IntegrationIsActive__c


DescriptionWhether integration is active (true) or not (false). The default checkbox value is selected.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



165


DetailsField

TypedateTime

LastViewedDate



Typestring

MaritalStatusCode__c


DescriptionThe system-defined code that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusLabel__c


DescriptionThe human-readable label that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusSystem__c


DescriptionThe system that defines the patient’s most recent civil marital status.

Typestring




Typeboolean

MultipleBirth__c


166


DetailsField

DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.

Typestring

Name


DescriptionThe EHR patient ID. Limit: 255 characters.

Typetextarea

Name__c


DescriptionThe long text description of a name associated with the patient.

Typestring

Organization255__c


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


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


DescriptionThe URL for a photo of the patient.

167


DetailsField

Typestring

PrefixName1__c


DescriptionThe first prefix in the patient’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the patient’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in the patient’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




168


DetailsField

Typestring

SuffixName1__c


DescriptionThe first suffix in the patient’s name.

Typestring

SuffixName2__c


DescriptionThe second suffix in the patient’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the patient’s name.

TypedateTime

Telecom1PeriodEndDate__c


DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom1PeriodStartDate__c


DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom1System__c


169


DetailsField

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom1Use__c


DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom1Value__c


DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime




TypedateTime




Typestring

Telecom2System__c



170


DetailsField

Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c


171


DetailsField


Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



172


DetailsField

Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c


173


DetailsField


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.

EhrPatientCareProviderRepresents the patient’s nominated care provider.


Fields

DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate




174

EhrPatientCareProviderHealth Cloud Developer Guide

DetailsField


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR patient care provider ID. Limit: 255 characters.

Typestring

Organization255__c


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


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

175


DetailsField


DescriptionThe patient’s name.

Typereference

Practitioner__c


DescriptionThe practitioner’s name. Lookup to EhrPractitioner__c.

Typestring

PractitionerName255__c


DescriptionThe practitioner’s name. Limit: 255 characters.

Typestring

PractitionerName__c


DescriptionThe long text description of the practitioner’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



Typestring


176


DetailsField



EhrPatientContact__cRepresents a contact party (for example, a guardian, partner, or friend) for the patient.


Fields

DetailsField

Typestring

Address1City__c


DescriptionThe city in an address for the patient contact.

Typestring

Address1Country__c


DescriptionThe country in an address for the patient contact.

TypedateTime

Address1EndDate__c


DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address1Line1__c

177

EhrPatientContact__cHealth Cloud Developer Guide

DetailsField


DescriptionThe first line of a street address for the patient contact.

Typestring

Address1Line2__c


DescriptionThe second line of a street address for the patient contact.

Typestring



DescriptionThe postal code of an address for the patient contact.

TypedateTime



DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address1State__c


DescriptionThe state in an address for the patient contact.

Typetextarea

Address1Text__c


DescriptionA complete address for the patient contact.

Typestring

Address1Use__c

178


DetailsField


DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



Typestring


179


DetailsField



TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



Typestring

Address3Country__c

180


DetailsField



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




Typestring

Address3State__c

181


DetailsField



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c

182


DetailsField



Typestring

Address4Line2__c



Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c

183


DetailsField



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



Typestring


184


DetailsField



TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



Typestring

FamilyName1__c


DescriptionThe first name in the patient contact’s family name (Smith in Carol Smith Rodgers Andrews)

Typestring

FamilyName2__c

185


DetailsField


DescriptionThe second name in the patient contact’s family name (Rodgers in Carol Smith RodgersAndrews)

Typestring

FamilyName3__c


DescriptionThe third name in the patient contact’s family name (Andrews in Carol Smith RodgersAndrews)

Typestring

GenderCode__c


DescriptionThe system-defined code that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

Typestring

GenderLabel__c


DescriptionThe human-readable label that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

Typestring

GenderSystem__c


DescriptionThe system that defines the gender that the patient contact is considered to have foradministration and record-keeping purposes.

Typestring

GivenName1__c


186


DetailsField

DescriptionThe first name in the patient contact’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName2__c


DescriptionThe second name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName3__c


DescriptionThe third name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName4__c


DescriptionThe fourth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName5__c


DescriptionThe fifth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typeboolean

IsRestricted__c



187


DetailsField

Typeboolean




Typedate

LastActivityDate


Description

TypedateTime

LastReferencedDate





TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR patient contact ID. Limit: 255 characters.

Typetextarea

Name__c


188


DetailsField

DescriptionThe long text description of the name of the patient contact.

Typestring

Organization255__c


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


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


DescriptionThe patient’s name.

TypedateTime

PeriodEnd__c


DescriptionThe last day when the contact or organization is valid and can be contacted regarding thepatient.

TypedateTime

PeriodStart__c


DescriptionThe first day when the contact or organization is valid and can be contacted regarding thepatient.

189


DetailsField

Typestring

PrefixName1__c


DescriptionThe first prefix in a patient contact name.

Typestring

PrefixName2__c


DescriptionThe second prefix in a patient contact name.

Typestring

PrefixName3__c


DescriptionThe third prefix in a patient contact name.

Typestring

RelationshipCode__c


DescriptionThe system-defined code that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipLabel__c


DescriptionThe human-readable label that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipSystem__c


190


DetailsField

DescriptionThe system that defines the nature of the relationship between the patient and the patientcontact.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

SuffixName1__c


DescriptionThe first suffix in a patient contact name.

Typestring

SuffixName2__c


DescriptionThe second suffix in a patient contact name.

Typestring

SuffixName3__c

191


DetailsField


DescriptionThe third suffix in a patient contact name.

TypedateTime



DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime



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



Typestring

Telecom1Use__c


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


192


DetailsField


TypedateTime




TypedateTime




Typestring

Telecom2System__c



Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



193


DetailsField

TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c



TypedateTime


194


DetailsField



TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



Typestring

Telecom4Value__c



TypedateTime



195


DetailsField


TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c



EhrPractitioner__cRepresents a person who’s involved in the providing of healthcare.

196

EhrPractitioner__cHealth Cloud Developer Guide


Fields

DetailsField

Typestring

Address1City__c


DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Country__c


DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address1EndDate__c


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


DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address1Line2__c


197


DetailsField

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring



DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime



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


DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address1Text__c


DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Use__c


198


DetailsField

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



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c


199


DetailsField


Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c


200


DetailsField


Typestring

Address3City__c



Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c


201


DetailsField


Typestring




TypedateTime




Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c


202


DetailsField


Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



Typestring

Address4Line2__c


203


DetailsField


Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c


204


DetailsField


Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c


205


DetailsField


Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c


206


DetailsField


TypedateTime

BirthDate__c


DescriptionThe practitioner’s birth date, needed for identification.

Typestring



DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring



DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring



DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring




207


DetailsField

Typestring




Typestring




Typestring




Typestring




Typestring




Typestring


208


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



209


DetailsField


Typestring

FamilyName1__c


DescriptionThe first name in the practitioner’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c


DescriptionThe second name in the practitioner’s family name (Rodgers in Carol Smith Rodgers Andrews).

Typestring

FamilyName3__c


DescriptionThe third name in the practitioner’s family name (Andrews in Carol Smith Rodgers Andrews).

Typestring

Gender__c


DescriptionThe gender that the practitioner is considered to have for administration and record-keepingpurposes, needed to address the practitioner correctly.

Typestring

GivenName1__c


DescriptionThe first name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

210


DetailsField

Typestring

GivenName2__c


DescriptionThe second name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c


DescriptionThe third name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName4__c


DescriptionThe fourth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c


DescriptionThe fifth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typeboolean

IsRestricted__c



Typeboolean


211


DetailsField



Typestring

Location1City__c


DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location1Country__c


DescriptionThe country associated with a location where the practitioner provides care.

Typestring



DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location1EndDate__c


DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location1Id__c


DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location1Line1__c

212


DetailsField


DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location1Line2__c


DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location1Name__c


DescriptionThe name of a location where the practitioner provides care.

Typestring



DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime



DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location1State__c


DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime


213


DetailsField


DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime



DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring



DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring



DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring



DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location1Text__c


214


DetailsField

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location1Type__c


DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location1Use__c


DescriptionDetails such as home or office related to a location where the practitioner provides care.

Typestring

Location2City__c



Typestring

Location2Country__c



Typestring




TypedateTime

Location2EndDate__c


215


DetailsField


Typestring

Location2Id__c



Typestring

Location2Line1__c



Typestring

Location2Line2__c



Typestring

Location2Name__c


DescriptionThe name of a location where the practitioner provides care

Typestring




TypedateTime



216


DetailsField


Typestring

Location2State__c



TypedateTime




TypedateTime




Typestring




Typestring




217


DetailsField

Typestring




Typetextarea

Location2Text__c



Typestring

Location2Type__c



Typestring

Location2Use__c



Typestring

Location3City__c



Typestring

Location3Country__c


218


DetailsField


Typestring




TypedateTime

Location3EndDate__c



Typestring

Location3Id__c



Typestring

Location3Line1__c



Typestring

Location3Line2__c



Typestring

Location3Name__c


219


DetailsField


Typestring




TypedateTime




Typestring

Location3State__c



TypedateTime




TypedateTime




Typestring


220


DetailsField



Typestring




Typestring




Typetextarea

Location3Text__c



Typestring

Location3Type__c



Typestring

Location3Use__c


DescriptionDetails such as home or office about a location where the practitioner provides care.

221


DetailsField

Typestring

Location4City__c



Typestring

Location4Country__c



Typestring




TypedateTime

Location4EndDate__c



Typestring

Location4Id__c



Typestring

Location4Line1__c



222


DetailsField

Typestring

Location4Line2__c



Typestring

Location4Name__c



Typestring




TypedateTime




Typestring

Location4State__c



TypedateTime



223


DetailsField


TypedateTime




Typestring




Typestring




Typestring




Typetextarea

Location4Text__c



224


DetailsField

Typestring

Location4Type__c



Typestring

Location4Use__c



Typestring

Location5City__c



Typestring

Location5Country__c



Typestring




TypedateTime

Location5EndDate__c



225


DetailsField

Typestring

Location5Id__c



Typestring

Location5Line1__c



Typestring

Location5Line2__c



Typestring

Location5Name__c



Typestring




TypedateTime




226


DetailsField

Typestring

Location5State__c



TypedateTime




TypedateTime




Typestring




Typestring




Typestring


227


DetailsField



Typetextarea

Location5Text__c



Typestring

Location5Type__c



Typestring

Location5Use__c



Typestring

Name


DescriptionThe EHR practitioner ID. Limit: 255 characters.

Typestring

Name255__c


DescriptionThe name of the practitioner. Limit: 255 characters.

228


DetailsField

Typetextarea

Name__c


DescriptionThe long text description of the practitioner’s name.

Typestring

Organization255__c


DescriptionThe organization where the practitioner performs the associated roles. Limit: 255 characters.

Typetextarea

Organization__c


DescriptionThe long text description of the organization where the practitioner performs the associatedroles.

Typereference

OwnerId


Description

Typestring

Period__c


DescriptionThe period during which the practitioner is authorized to act as a practitioner in these rolesfor the organization.

Typetextarea

PhotoUrl__c


229


DetailsField

DescriptionThe URL for a photo of the practitioner.

Typestring

PrefixName1__c


DescriptionThe first prefix in the practitioner’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the practitioner’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in the practitioner’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime



230


DetailsField


Typestring

SpecialtyCode__c


DescriptionThe system-defined code that represents a specialty of the practitioner’s.

Typestring

SpecialtySystem__c


DescriptionThe system that defines a specialty of the practitioner’s.

Typestring

SuffixName1__c


DescriptionThe first suffix in the practitioner’s name.

Typestring

SuffixName2__c


DescriptionThe second suffix in the practitioner’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the practitioner’s name.

TypedateTime



231


DetailsField

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime



DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom1System__c


DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom1Use__c


DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

Typestring

Telecom1Value__c


DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

TypedateTime




TypedateTime


232


DetailsField



Typestring

Telecom2System__c



Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



TypedateTime




TypedateTime




233


DetailsField

Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c


234


DetailsField


Typestring

Telecom4Use__c



Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c

235


DetailsField



Typestring

Telecom5Value__c



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__cRepresents external identities such as licenses and regional identifiers for a practitioner.


Fields

DetailsField

Typestring

Description__c


DescriptionThe description of the identifier.

Typereference

EhrPractitioner__c


236

EhrPractitionerIdentity__cHealth Cloud Developer Guide

DetailsField

DescriptionA person who’s involved in the providing of healthcare.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR practitioner identity name. Limit: 255 characters.

Typestring

Organization__c


DescriptionThe organization that the external identifier applies to. Limit: 255 characters.

237


DetailsField

Typedate

PeriodEndDate


DescriptionThe date when the identifier expires.

Typedate

PeriodStartDate


DescriptionThe first date when the identifier is active.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

System__c


DescriptionThe system that defines the practitioner identity.

238


DetailsField

Typestring

TypeCode__c


DescriptionThe system-defined code that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeSystem__c


DescriptionThe system that defines the practitioner identity type.

Typestring

Use__c


Description

Typestring

Value__c


DescriptionAn identifier for the external system.

EhrPractitionerQualification__cRepresents qualifications obtained by the practitioner through training and certification.

239

EhrPractitionerQualification__cHealth Cloud Developer Guide


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents a practitioner qualification.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents a practitioner qualification.

Typestring

CodeSystem__c


DescriptionThe system that defines a practitioner qualification.

Typeboolean

IsRestricted__c



Typestring

Issuer255__c


DescriptionThe organization that regulates and issues the qualification. Limit: 255 characters.

240


DetailsField

Typestring

Issue__c


DescriptionThe long text description of the organization that regulates and issues the qualification.

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


241


DetailsField

DescriptionThe EHR practitioner qualification ID. Limit: 255 characters.

Typedate

PeriodEnd__c


DescriptionThe last date when a qualification is valid.

Typedate

PeriodStart__c


DescriptionThe first date when a qualification is valid.

Typereference

Practitioner__c



Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime



242


DetailsField


EhrPractitionerRole__cRepresents a list of roles that the practitioner can perform for a given time period.


Fields

DetailsField

Typereference

EhrPractitioner__c



TypedateTime

EndDate__c


DescriptionThe last date when the practitioner is authorized to act as a practitioner in these roles for theorganization.

Typeboolean

IsRestricted__c



Typeboolean



243

EhrPractitionerRole__cHealth Cloud Developer Guide

DetailsField


Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR practitioner role ID. Limit: 255 characters.

Typestring

RoleCode__c


DescriptionThe system-defined code that represents the practitioner’s role.

Typestring

RoleLabel__c


DescriptionThe human-readable label that represents the practitioner’s role.

Typestring

RoleSystem__c


DescriptionThe system that defines the practitioner’s role.

244


DetailsField

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

Specialty1Code__c


DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty1Label__c


DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty1System__c


DescriptionThe system that defines a specialty of the practitioner.

245


DetailsField

Typestring

Specialty2Code__c



Typestring

Specialty2Label__c



Typestring

Specialty2System__c



Typestring

Specialty3Code__c



Typestring

Specialty3Label__c



Typestring

Specialty3System__c



246


DetailsField

Typestring

Specialty4Code__c



Typestring

Specialty4Label__c



Typestring

Specialty4System__c



Typestring

Specialty5Code__c



Typestring

Specialty5Label__c



Typestring

Specialty5System__c



247


DetailsField

TypedateTime

StartDate__c


DescriptionThe first date when the practitioner is authorized to act as a practitioner in these roles forthe organization.

EhrProcedure__cA medical action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counselingor hypnotherapy.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient.

Typestring

BodySite__c


DescriptionAnatomical location for the procedure.

Typestring

Category__c


248

EhrProcedure__cHealth Cloud Developer Guide

DetailsField

DescriptionHigh-level categorization of the procedure.

Typestring

Code__c


DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c


DescriptionIndustry-standard name for the procedure.

Typestring

Complication__c


DescriptionCode that identifies any resulting complication.

Typereference

Encounter__c


DescriptionEncounter associated with the procedure.

Typetextarea

FollowUpInstructions__c


DescriptionInstructions for follow-up care.

Typetextarea

ItemsUsed__c

PropertiesCreate, , , Nillable, , Update

249


DetailsField

DescriptionItems used during the procedure.

Typestring

Location__c


DescriptionPhysical location where the procedure was performed, such as a clinic or medical office.

Typetextarea

Notes__c


DescriptionAdditional information about the procedure.

Typeboolean

NotPerformed__c


DescriptionWhether the procedure was not performed as scheduled.

Typestring

Outcome__c


DescriptionResult of the procedure.

TypedateTime

PerformedDateTime__c

PropertiesCreate, Filter, , Nillable, Sort, Update

DescriptionDate and time that the procedure was performed.

Typestring

Reason1__c


250


DetailsField

DescriptionReason that the procedure was requested.

Typestring

Reason2__c



Typestring

Reason3__c



Typestring

Reason4__c



Typestring

ReasonNotPerformed__c


DescriptionReason that the procedure was not performed.

Typestring

Report__c


DescriptionName of the report related to the procedure.

Typereference

Request__c


251


DetailsField

DescriptionReference to the request for the procedure.

Typestring

SourceSystemId__c


DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status_c


DescriptionStatus of the procedure. Picklist values: Completed, Entered in Error, In Progress, NotCompleted.

EhrProcedurePerformer__cA junction object that relates EhrProcedure__c and EhrPractitioner__c.


Fields

DetailsField

Typereference

EHRPractitioner__c


DescriptionPractitioner involved in the procedure. Lookup to Practitioner__c.

Typereference

EHRProcedure__c


252

EhrProcedurePerformer__cHealth Cloud Developer Guide

DetailsField

DescriptionProcedure performed by the practitioner. Lookup to Procedure__c.

Typestring

PerformerRole__c


DescriptionPractitioner’s role during the procedure.

EhrProcedureRequest__cRepresents a request for a procedure to be performed. It can be used to represent a procedure that is planned, proposed, or ordered.


Fields

DetailsField

Typereference

Account__c


DescriptionName of the person the procedure was performed on.

Typestring

BodySite__c


DescriptionAnatomical location for the procedure.

Typestring

Category__c


253

EhrProcedureRequest__cHealth Cloud Developer Guide

DetailsField

DescriptionHigh-level categorization of the procedure.

Typestring

Code__c


DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c


DescriptionIndustry-standard name for the procedure.

Typereference

Encounter__c


DescriptionEncounter associated with the procedure.

Typetextarea

Notes__c


DescriptionAdditional information about the procedure.

Typereference

OrderedBy__c


DescriptionName of the practitioner making the request.

TypedateTime

OrderedOn__c


254


DetailsField

DescriptionDate and time the request was created.

Typepicklist

Priority__c


DescriptionPriority of the procedure. Picklist values: ASAP, Routine, Stat, Urgent.

Typestring

Reason1__c



Typestring

Reason2__c



Typestring

Reason3__c



Typestring

Reason4__c



TypedateTime

ScheduledDateTime__c


255


DetailsField

DescriptionScheduled date and time to perform the procedure.

Typestring

SourceSystemId__c


DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status__c


DescriptionStatus of the procedure request. Picklist values: Accepted, Completed, Draft, In Progress, NotCompleted, Proposed, Received, Rejected, Requested, Suspended.

EhrProgram__cRepresents 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.


Fields

DetailsField

Typedate

EndDate__c


DescriptionThe date when the program ends.

Typeboolean

IsActive__c

256

EhrProgram__cHealth Cloud Developer Guide

DetailsField


DescriptionIndicates whether the program is active.

Typecurrency

Rate__c


DescriptionThe reimbursement rate for the measurement period of a patient’s program.

Typestring

ReportName__c


DescriptionName of the Wave report that uses this information.

Typedate

StartDate__c


DescriptionThe date when the program begins.

Typedouble

Target__c


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.

257

EhrProgram__cHealth Cloud Developer Guide

DetailsField

Typepicklist

UnitOfMeasure__c


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


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.

EhrRelatedObservation__cRepresents 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.


Fields

DetailsField

Typeboolean

IsRestricted__c



Typeboolean


258

EhrRelatedObservation__cHealth Cloud Developer Guide

DetailsField



Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR related observation name. Limit: 255 characters.

Typereference

Observation__c


259


DetailsField

DescriptionThe measurements and assertions made, regarding a patient or device, that this observationis related to.

Typereference

RelatedObservation__c


DescriptionThe related observation. Lookup to EhrObservation__c.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typepicklist

Type__c


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

260


DetailsField


DescriptionThe system-defined code that represents the type of relationship that exists with the targetobservation.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the type of relationship that exists with the targetobservation.

Typestring

TypeSystem__c


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__cRepresents 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.


261

EhrRelatedPerson__cHealth Cloud Developer Guide

Fields

DetailsField

Typereference

Account__c



Typestring

Address1City__c


DescriptionThe city in an address for the related person.

Typestring

Address1Country__c


DescriptionThe country in an address for the related person.

TypedateTime

Address1EndDate__c


DescriptionThe last date when an address for the related person is valid.

Typestring

Address1Line1__c


DescriptionThe first line of a street address for the related person.

Typestring

Address1Line2__c


262


DetailsField

DescriptionThe second line of a street address for the related person.

Typestring



DescriptionThe postal code of an address for the related person.

TypedateTime



DescriptionThe first date when an address for the related person is valid.

Typestring

Address1State__c


DescriptionThe state in an address for the related person.

Typetextarea

Address1Text__c


DescriptionA complete address for the related person.

Typestring

Address1Use__c


DescriptionDetails such as home or office related to an address for the related person.

Typestring

Address2City__c


263


DetailsField


Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



Typestring




TypedateTime



264


DetailsField


Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



Typestring

Address3Country__c



TypedateTime

Address3EndDate__c


265


DetailsField


Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




Typestring

Address3State__c



Typetextarea

Address3Text__c


266


DetailsField


Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



Typestring

Address4Line2__c


267


DetailsField


Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c



Typestring

Address5City__c


268


DetailsField


Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



Typestring




TypedateTime



269


DetailsField


Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



TypedateTime

BirthDate__c


DescriptionThe related person’s birth date.

Typestring

FamilyName1__c


DescriptionThe first name in the related person’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c


270


DetailsField

DescriptionThe second name in the related person’s family name (Rodgers in Carol Smith RodgersAndrews).

Typestring

FamilyName3__c


DescriptionThe third name in the related person’s family name (Andrews in Carol Smith RodgersAndrews).

Typestring

Gender__c


DescriptionThe related person’s gender.

Typestring

GivenName1__c



Typestring

GivenName2__c



Typestring

GivenName3__c



271


DetailsField

Typestring

GivenName4__c



Typestring

GivenName5__c



Typeboolean

IsRestricted__c



Typeboolean




Typestring

Language1__c


DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language2__c


272


DetailsField


Typestring

Language3__c



Typestring

Language4__c



Typestring

Language5__c



Typedate

LastActivityDate





TypedateTime

LastReferencedDate


273


DetailsField


TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR related person ID. Limit: 255 characters.

Typetextarea

NameFull__c


DescriptionThe long text description of the related person’s full name.

Typereference

Patient__c



Typetextarea

PhotoUrl__c


DescriptionThe URL to a photo of the related person.

Typestring

PrefixName1__c


274


DetailsField

DescriptionThe first prefix in the related person’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the related person’s name.

Typestring

PrefixName3__c


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


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


275


DetailsField


Typestring

SourceSystemId__c



TypedateTime




Typestring

Specialty255__c


DescriptionThe related person’s specialty. Limit: 255 characters.

Typetextarea

Specialty__c


DescriptionThe long text description of the related person’s specialty.

Typestring

SuffixName1__c


DescriptionThe first suffix in the related person’s name.

Typestring

SuffixName2__c


276


DetailsField

DescriptionThe second suffix in the related person’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the related person’s name.

TypedateTime



DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime



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


DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom1Use__c


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.

277


DetailsField

Typestring

Telecom1Value__c


DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

TypedateTime




TypedateTime




Typestring

Telecom2System__c



Typestring

Telecom2Use__c



Typestring

Telecom2Value__c

278


DetailsField



TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c


279


DetailsField


TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



Typestring

Telecom4Value__c


280


DetailsField


TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c


281


DetailsField


EhrVaccinationProtocol__cRepresents information about the protocol under which a vaccine is administered.


Fields

DetailsField

Typestring

Authority255__c


DescriptionThe authority who published the protocol. Limit: 255 characters.

Typetextarea

Authority__c


DescriptionThe long text description of the authority who published the protocol. Limit: 255 characters.

Typetextarea

Description__c


DescriptionThe long text description of the protocol under which a vaccine is administered.

Typestring

DoseReasonLabel__c


282

EhrVaccinationProtocol__cHealth Cloud Developer Guide

DetailsField

DescriptionThe human-readable label that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.

Typedouble

DoseSequence__c


DescriptionThe dose number within a series of doses.

Typestring

DoseStatusCode__c


DescriptionThe system-defined code that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusLabel__c


DescriptionThe human-readable label that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusReasonCode__c


DescriptionThe system-defined code that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.

Typestring

DoseStatusReasonSystem__c


DescriptionThe system that defines an explanation as to why an immunization event counts or doesn’tcount against the protocol.

283


DetailsField

Typestring

DoseStatusSystem__c


DescriptionThe system that defines whether an immunization event counts or doesn’t count againstthe protocol.

Typestring

DoseTargetCode__c


DescriptionThe system-defined code that represents the disease that the dose targets.

Typestring

DoseTargetLabel__c


DescriptionThe human-readable label that represents the disease that the dose targets.

Typestring

DoseTargetSystem__c


DescriptionThe system that defines the disease that the dose targets.

Typereference

Immunization__c


DescriptionInformation about an immunization event.

Typeboolean

IsRestricted__c


284


DetailsField


Typeboolean




TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR vaccination protocol ID. Limit: 255 characters.

Typestring

Series__s


DescriptionThe name of the vaccine series: a possible path to achieve presumed immunity against adisease, within the context of an authority.

Typedouble

SeriesDoses__s

285


DetailsField


DescriptionThe recommended number of doses for achieving immunity.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




EhrVirtualDevice__cRepresents a group of related data items.


Fields

DetailsField

Typestring

Code__c

286

EhrVirtualDevice__cHealth Cloud Developer Guide

DetailsField


DescriptionThe system-defined code that represents the virtual device.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



287

EhrVirtualDevice__cHealth Cloud Developer Guide

DetailsField

Typestring

Name


DescriptionThe EHR virtual device ID. Limit: 255 characters.

Typereference

OwnerId


Description

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




EhrVirtualDeviceChannel__cRepresents the channel a virtual device operates on.

288

EhrVirtualDeviceChannel__cHealth Cloud Developer Guide


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents the virtual device channel.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents the virtual device channel.

Typestring

CodeSystem__c


DescriptionThe system that defines the virtual device channel.

Typereference

EhrVirtualDevice__c


DescriptionA group of related data items. Lookup to EhrVirtualDevice__c.

Typeboolean

IsRestricted__c



289


DetailsField

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typetextarea

Metric__c


DescriptionThe long text description of a piece of data reported by the device for the channel.

Typestring

Name


290


DetailsField

DescriptionThe EHR virtual device channel name. Limit: 255 characters.

Typereference

Observation__c


DescriptionThe data for the metric. Lookup to EhrObservation__c.

Typereference

OwnerId


Description

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




291


Health Cloud Custom Objects

CarePlanTemplate__cRepresents 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


DescriptionA description of the template.

UsageUse this object to manage patient care templates.

292

Health Cloud Custom ObjectsHealth Cloud Developer Guide

CarePlanTemplateGoal__cRepresents a goal included in the care plan template.


Fields

DetailsField

Typeboolean

Active__c



Typetextarea

Description__c


DescriptionA description of the goal associated with the problem.

Typestring

Name


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

293

CarePlanTemplateGoal__cHealth Cloud Developer Guide

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


DescriptionIndicates the sort order of goals in the list.

Typereference

TemplateProblem___c


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__cRepresents a problem included in the care plan template.


Fields

DetailsField

Typeboolean

Active__c



294

CarePlanTemplateProblem__cHealth Cloud Developer Guide

DetailsField

Typereference

CarePlanTemplate__c

PropertiesCreate, Filter,Group, Nillable, Sort, Update

DescriptionThe care plan template that the problem is related to.

Typetextarea

Description__c


DescriptionA description of the problem associated with the template.

Typestring

Name


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


DescriptionThe priority of the care plan problem such as low, normal, or high.

Typedouble

SortOrder___c


DescriptionIndicates the sort order of problems in the list.

295

CarePlanTemplateProblem__cHealth Cloud Developer Guide

UsageUse this object to query and manage problems associated with a care plan template.

CarePlanTemplateTask__cRepresents a task that’s included in the care plan template.


Fields

DetailsField

Typeboolean

Active__c



Typepicklist

AssignedTo__c

PropertiesCreate, Filter, Group, Nillable,Restricted picklist, Sort, Update

DescriptionName of the person who’s assigned to the task.

Typereference

CarePlanTemplateGoal__c


DescriptionName of the goal associated with the task.

Typetextarea

Description__c


DescriptionA description of the task.

296

CarePlanTemplateTask__cHealth Cloud Developer Guide

DetailsField

Typestring

Name



Typedouble

Offset___c


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


DescriptionThe priority of the care plan task such as low, normal, or high.

Typedouble

SortOrder___c


DescriptionIndicates the sort order of tasks in the list.

Typepicklist

Status___c


DescriptionThe status of the care plan task such as in progress, complete, or new.

Typestring

Subject___c


297

CarePlanTemplateTask__cHealth Cloud Developer Guide

DetailsField

DescriptionThe subject or name of the task.

Typepicklist

Type__c


DescriptionThe type of task.

UsageUse this object to query and manage tasks associated with a care plan template.

AccountAccountRelation__cRepresents a one-to-one relationship between two accounts, each with a distinct role in relation to the other.


Fields

DetailsField

Typereference

Account__c


DescriptionAccount that RelatedAccount__c is related from.

Typeboolean

Active__c


DescriptionIndicates whether the relationship between accounts is active (true) or not (false). Thedefault checkbox value is selected.

298

AccountAccountRelation__cHealth Cloud Developer Guide

DetailsField

Typedate

EndDate__c


DescriptionThe last date when the two accounts are related.

Typestring

ExternalId__c


DescriptionAn external ID that inhibits any duplicate definitions from FromAccount- Role -ToAccount.

Typestring

Name


DescriptionThe name of the relationship between the accounts. Limit: 255 characters.

Typereference

OwnerId


DescriptionID of the user who created the relationship record.

Typereference

RelatedAccount__c


DescriptionAccount that Account__c is related to.

Typereference

Role__c


299

AccountAccountRelation__cHealth Cloud Developer Guide

DetailsField

DescriptionThe role of the relationship.

Typedate

StartDate__c


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__cRepresents the demographics and other administrative information about a patient who’s receiving health-related services.


Fields

DetailsField

Typestring

Address1City__c



Typestring

Address1Country__c



300

CandidatePatient__cHealth Cloud Developer Guide

DetailsField

TypedateTime

Address1EndDate__c



Typestring

Address1Line1__c



Typestring

Address1Line2__c



Typestring




TypedateTime




Typestring

Address1State__c



301


DetailsField

Typetextarea

Address1Text__c


DescriptionA complete address for the patient. Use is optional based on source data.

Typestring

Address1Use__c



Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



302


DetailsField

Typestring

Address2Line2__c



Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



303


DetailsField

Typestring

Address3City__c



Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




304


DetailsField

TypedateTime




Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



305


DetailsField

TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



Typestring

Address4Line2__c



Typestring




TypedateTime



DescriptionThe first date when an address for the patient is valid

Typestring

Address4State__c



306


DetailsField

Typetextarea

Address4Text__c



Typestring

Address4Use__c



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



307


DetailsField

Typestring

Address5Line2__c



Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



308


DetailsField

TypedateTime

BirthDate__c


DescriptionThe patient’s birth date.

Typestring




Typestring




Typestring




Typestring




Typestring


309


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



310


DetailsField


Typestring




Typestring




Typestring




Typestring




Typestring



311


DetailsField


Typeboolean

Deceased__c


DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.

Typestring

FamilyName1__c


DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c


DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).

Typestring

FamilyName3__c


DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).

Typestring

GenderCode__c


DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

312


DetailsField

Typestring

GenderLabel__c


DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderSystem__c


DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.

Typestring

GivenName1__c



Typestring

GivenName2__c



Typestring

GivenName3__c



Typestring

GivenName4__c


313


DetailsField


Typestring

GivenName5__c



Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MaritalStatusCode__c


DescriptionThe system-defined code that represents the patient’s most recent civil marital status.

314


DetailsField

Typestring

MaritalStatusLabel__c


DescriptionThe human-readable label that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusSystem__c


DescriptionThe system that defines the patient’s most recent civil marital status.

Typestring




Typeboolean

MultipleBirth__c


DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.

Typestring

Name


DescriptionThe EHR ADT patient ID. Limit: 255 characters.

Typetextarea

Name__c


315


DetailsField

DescriptionA long text description of a name associated with the patient.

Typestring

Organization255__c


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


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


Description

Typetextarea

PhotoUrl__c


DescriptionThe URL for a photograph of the patient.

Typestring

PrefixName1__c


DescriptionThe first prefix in a patient’s name.

Typestring

PrefixName2__c

316


DetailsField


DescriptionThe second prefix in a patient’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in a patient’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

SuffixName1__c


DescriptionThe first suffix in a patient’s name.

Typestring

SuffixName2__c

317


DetailsField


DescriptionThe second prefix in a patient’s name.

Typestring

SuffixName3__c


DescriptionThe third prefix in a patient’s name.

TypedateTime




TypedateTime




Typestring

Telecom1System__c


DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

Typestring

Telecom1Use__c


318


DetailsField

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

Typestring

Telecom1Value__c



TypedateTime




TypedateTime




Typestring

Telecom2System__c



Typestring

Telecom2Use__c



319


DetailsField

Typestring

Telecom2Value__c



TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c

320


DetailsField



TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



Typestring

Telecom4Value__c


321


DetailsField


TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c



322


CardViewDropdown__cDefines 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.


Fields

DetailsField

Typestring

Category__c


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


DescriptionDescibes the menu navigation item.

Typestring

ParamString__c


DescriptionAdd any extra URL parameters to the existing Visualforce page or URL to open the new tab.

Typestring

RecOpenType__c


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.

323

CardViewDropdown__cHealth Cloud Developer Guide

DetailsField

Typestring

SubCategory__c


DescriptionName of the child category in the menu list. This text is the clickable link that opens the pageor tab.

Typestring

Type__c


DescriptionContent type of the new page. Specify VFpage or URL.

Typestring

URL__c


DescriptionThe URL to access the page.

CarePlanGoal__cRepresents the intended objectives of carrying out a care plan.

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

Fields

DetailsField

Typereference

CarePlan__c


324

CarePlanGoal__cHealth Cloud Developer Guide

DetailsField

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a time period.Can be limited to care for a specific condition or set of conditions.

Typereference

CarePlanProblem__c


DescriptionThe health problem that this goal addresses.

Typetextarea

Description__c


DescriptionA long text description of the care plan.

Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



325


DetailsField

Typestring

Name


DescriptionThe name of the care plan goal. Limit: 255 characters.

Typestring

PercentBar___c


DescriptionPercent completed.

Typepicklist

Priority___c


DescriptionThe priority of the care plan goal. Picklist values: Low, Medium, and High.

Typepercent

Progress___c


DescriptionProgress toward achieving the care plan goal.

Typedouble

SortOrder___c


DescriptionThe order in which the goal appears among other goals associated with a problem.

UsageDevelopers can use an integration to build CarePlanGoal__c from data in EhrCarePlanGoal__c. Not required.

326


CarePlanProblem__cRepresents the conditions, problems, concerns, diagnoses, and so on, that this plan manages and mitigates.


Fields

DetailsField

Typereference

CarePlanTemplate__c


DescriptionThe care plan template associated with the problem.

Typereference

CarePlan__c



Typetextarea

Description__c


DescriptionA description of the care plan problem.

Typedate

LastActivityDate



• Due date of the most recent event logged against the record

• Due date of the most recently closed task associated with the record

327

CarePlanProblem__cHealth Cloud Developer Guide

DetailsField

TypedateTime

LastReferencedDate


DescriptionThe timestamp indicating when the user last viewed a related record.

TypedateTime

LastViewedDate


DescriptionThe timestamp indicating when the current user last viewed this record.

Typestring

Name



Typepicklist

Priority___c


DescriptionThe priority of the care plan problem. Picklist values: Low, Medium, and High.

Typedouble

SortOrder___c


DescriptionThe order in which the problem appears among other problems associated with the careplan.

328

CarePlanProblem__cHealth Cloud Developer Guide

UsageDevelopers can use an integration to build CarePlanProblem__c from data in EhrCarePlanConcern__c. Not required.

SEE ALSO:

CarePlanGoal__c

ConditionToHCCCodeMapping__cRepresents a mapping of patient conditions to Hierarchical Condition Category (HCC) codes.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search ( ),undelete(), update(), upsert()

Fields

DetailsField

Typeboolean

Active__c


DescriptionIndicates whether this condition to HCC mapping is active and available for use.

Typestring

ConditionCode__c


DescriptionA comma-separated list of conditions that apply to the patient.

Typestring

HCCCode__c


DescriptionHCC codes that apply to the patient’s condition.

Typedouble

ValidFrom__c

329

ConditionToHCCCodeMapping__cHealth Cloud Developer Guide

DetailsField

PropertiesCreate, Filter, Sort, Update

DescriptionThe year in which the HCC codes become valid.

Typedouble

ValidThrough__c


DescriptionThe last year in which the HCC codes are valid.

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__cRepresents a relationship between two contacts, each with a distinct role in relation to the other.


Fields

DetailsField

Typeboolean

Active__c


330

ContactContactRelation__cHealth Cloud Developer Guide

DetailsField

DescriptionIndicates whether the relationship is active (true) or not (false). The default checkboxvalue is selected.

Typereference

Contact__c


DescriptionContact that RelatedContact__c is related from.

Typedate

EndDate__c


DescriptionThe last date when the relationship between contacts is valid.

Typestring

ExternalId__c


DescriptionAn external ID that inhibits any duplicate definitions from FromContact - Role -ToContact.

Typestring

Name


DescriptionThe name of the relationship between the contacts. Limit: 255 characters.

Typereference

OwnerId


Description

Typereference

RelatedContact__c

331

ContactContactRelation__cHealth Cloud Developer Guide

DetailsField


DescriptionContact that RelatedContact__c is related to.

Typereference

Role__c


DescriptionRole that describes how RelatedContact__c is related to Contact__c

Typedate

StartDate__c


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__cRepresents a relationship between two objects (for example, patient Account and EhrPatient__c) used in patient list view pages.


Fields

DetailsField

Typestring

FromObject__c


332

CrossObjectRelationship__cHealth Cloud Developer Guide

DetailsField

DescriptionThe related from object.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the relationship between the objects. Limit: 255 characters.

Typereference

OwnerId


DescriptionThe owner of the record.

Typestring

Relationship__c


DescriptionThe relationship between the objects.

Typestring

ReverseRelationship__c


333

CrossObjectRelationship__cHealth Cloud Developer Guide

DetailsField

DescriptionThe reverse relationship between the objects.

Typestring

ToObject__c


DescriptionThe related to object.

CustomFieldSets__cRepresents a custom grouping of fields

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

Fields

DetailsField

Typetextarea

ExcludedFields__c


DescriptionFields that aren’t included in the field set.

Typestring

FieldSetLabel__c


DescriptionLabel for the field set.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Sort, Update

334

CustomFieldSets__cHealth Cloud Developer Guide

DetailsField

DescriptionThe name of the custom field set. Limit: 255 characters.

Typestring

SObjectName


DescriptionThe name of the sObject. Limit: 255 characters.

Typeboolean

TwoColumnLayout


DescriptionWhether the layout is two-column (true) or not (false).

CustomLabelConfig__cRepresents 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


335

CustomLabelConfig__cHealth Cloud Developer Guide

DetailsField

DescriptionName of the new label.

Typestring

ObjectFieldName__c


DescriptionThe name of the object field.

Typestring

ObjectName__c


DescriptionThe name of the object.

Typestring

ObjectRecordType__c


DescriptionThe object record type.

Typestring

RelationshipName__c


DescriptionThe name of the relationship.

Typestring

ViewName__c


DescriptionThe name of the view.

FilterColumn__cRepresents the column used by filter criteria for the patient segmentation functionality.

336

FilterColumn__cHealth Cloud Developer Guide


Fields

DetailsField

Typestring

FieldApi__c


DescriptionThe selected field.

Typestring

FieldLabel__c


DescriptionLabel of the selected field.

Typereference

FilterCriterion__c


DescriptionThe field criterion.

Typestring

Name


DescriptionThe filter column name. Limit: 255 characters.

Typetextarea

ObjectName__c


DescriptionA long text description of the name of the object.

337

FilterColumn__cHealth Cloud Developer Guide

DetailsField

Typedouble

Order__c


DescriptionOrder in which the field appears.

FilterCondition__cRepresents the condition used by filter criteria for the patient segmentation functionality.


Fields

DetailsField

Typestring

FieldName__c


DescriptionThe name of the field.

Typereference

FieldCriterion__c


DescriptionThe field criterion.

Typestring

Name


DescriptionThe name of the filter condition. Limit: 255 characters.

338

FilterCondition__cHealth Cloud Developer Guide

DetailsField

Typetextarea

ObjectName__c



Typestring

Operator__c


DescriptionThe filter criteria operator.

Typedouble

RowNumber__c


DescriptionNumber of rows.

Typestring

SRowNumber__c


DescriptionThe number of rows to display.

Typestring

Type__c


DescriptionThe type of filter condition.

Typestring

Value__c


DescriptionA value entered in the filter condition.

339

FilterCondition__cHealth Cloud Developer Guide

FilterCriterion__cRepresents the filter criteria for the patient segmentation functionality. Consists of a list of filter conditions and a list of columns thatdisplay 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


DescriptionGrouping of the filter items.

Typeboolean

IsWaveList__c


DescriptionIndicates whether a patient list originated from the Wave for Health Cloud app.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

340

FilterCriterion__cHealth Cloud Developer Guide

DetailsField


DescriptionThe name of the filter criterion. Limit: 255 characters.

Typetextarea

ObjectName__c



Typereference

OwnerId


DescriptionID of the record’s owner.

PatientCardViewConfiguration__cRepresents configuration options for the patient card.

Supported Callscreate(), delete(), query(), retrieve(), search(), undelete(), update()

Fields

DetailsField

Typestring

FieldName__c


DescriptionName of the field that contains the information to display on the patient card.

Typestring

FriendlyName__c

341

PatientCardViewConfiguration__cHealth Cloud Developer Guide

DetailsField


DescriptionName that appears as a title on the patient card.

Typeboolean

IsActive__c


DescriptionIndicates whether this field is appears on the patient card.

Typeboolean

IsAscending__c


DescriptionIndicates whether results appear in ascending order.

Typestring

LanguageCode__c


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


DescriptionIndicates the maximum number of results to display in the field.

Typestring

ObjectName__c

342


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


DescriptionName of the custom filter field to replace the delivered one.

Typestring

PatientAccountLookup__c


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


DescriptionThe name of the field used to define the order in which the results appear.

Typedouble

SortOrder__c


DescriptionIndicates the vertical order in which this field appears on the patient card.

343


UsageThis resource lets you customize the patient card and add the fields of your choice.

ReciprocalRole__cRepresents an inverse role. For example, if one role is parent, the reciprocal role is child.


Fields

DetailsField

Typeboolean

CreateInverseRole__c


DescriptionIndicates whether the corresponding reciprocal role record is created automatically for theinverse role (true) or not (false).

Typereference

InverseRelationship__c


DescriptionUniquely identifies the relationship between Role and InverseRole__c so that itcan be referenced by a trigger that creates the inverse relationship record.

Typestring

InverseRole__c


DescriptionThe other role that is related.

Typestring

Name


344

ReciprocalRole__cHealth Cloud Developer Guide

DetailsField

DescriptionThe name of the role. Limit: 255 characters.

Typereference

OwnerId


Description<Get description>

Typepicklist

RelationshipType__c


DescriptionPicklist values: Account Account Relation, All, and Contact Contact Relation.

Typestring

Role


DescriptionThe role that an entity occupies in the relationship, such as a grandchild or a businessproprietor.

ProgramPatientAffiliation__cRepresents the program that the patient is affiliated with.


Fields

DetailsField

Typereference

Account__c


345

ProgramPatientAffiliation__cHealth Cloud Developer Guide

DetailsField

DescriptionLookup to the Account object.

Typedate

EndDate__c


DescriptionThe date when the patient’s enrollment in the program ends.

Typeboolean

IsActive__c


DescriptionIndicates whether the enrollment of the person in the associated program is active.

Typereference

Program__c


DescriptionThe program in which the patient is enrolled.

Typeboolean

Recalculate__c


DescriptionIndicates whether new and relevant information about the patient has been received thattriggers a recalculation of the appropriate program metrics.

Typereference

Provider


DescriptionName of the physician or other healthcare provider.

Typedate

StartDate__c

346

ProgramPatientAffiliation__cHealth Cloud Developer Guide

DetailsField


DescriptionThe date when the patient’s enrollment in the program ends.

Typepicklist

Status__c


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__cRepresents a record that contains calculated values for the relevant program that the patient is enrolled in.


Fields

DetailsField

Typereference

Account__c



Typedouble

Age__c

PropertiesCreate, Filter, Sort, Update

347

ProgramPatientSummary__cHealth Cloud Developer Guide

DetailsField

DescriptionThe patient’s age in years as of December 31 for the year being calculated.

Typestring

AgeBand__c


DescriptionThe age group in which the patient belongs. For example, 35–44, 55–59, and so on.

Typetextarea

Conditions__c


DescriptionA list of Hierarchical Condition Category (HCC) codes associated with the patient.

Typeboolean

DisabilityStatus__c


DescriptionIndicates whether the patient is considered disabled according to the Centers for Medicareand Medicaid Services (CMS) guidelines.

Typedate

EffectiveDate__c


DescriptionThe date when the risk score was calculated.

Typepicklist

EnrollmentType__c


DescriptionIndicates the Medicare enrollment type for the patient.

Typepicklist

Gender__c

348


DetailsField


DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.

Typestring

HCCCodes__c


DescriptionHCC codes that apply to the patient for the year.

Typeboolean

Institution__c


DescriptionIndicates whether the patient is in an institution.

Typeboolean

LowIncome__c


DescriptionIndicates whether the patient falls within low-income guidelines.

Typestring

Month__c


DescriptionThe month that the time spent applies.

Typeboolean

MostRecent__c


DescriptionIndicates whether this record contains the most recent calculation for the measurementperiod.

349


DetailsField

Typeboolean

NewPatient__c


DescriptionIndicates whether the person is a new Medicare patient or a continued enrollee.

Typestring

NumberOfConditions__c


DescriptionThe number of HCC codes associated with the patient.

Typereference

ProgramPatientAffiliation__c


DescriptionLookup to the ProgramPatientAffiliation object.

Typedouble

RiskScore__c

PropertiesCreate, Filter, NillableSort, Update

DescriptionThe patient’s calculated HCC risk score.

Typepicklist

Stage__c


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


350


DetailsField

DescriptionThe total time spent with the patient on qualifying activities during the measurement period.

Typestring

Unique__c


DescriptionA key used for time calculations.

Typestring

Year__c


DescriptionThe year that the risk score applies to.

UsageUse this object to store calculated information for a patient’s program.

Provider__cRepresents a person providing healthcare.


Fields

DetailsField

Typeboolean

Active__c


DescriptionIndicates whether this provider is actively practicing.

351

Provider__cHealth Cloud Developer Guide

DetailsField

Typereference

EHRPractitioner__c


DescriptionLookup to the EhrPractictioner object.

Typereference

RelatedContact__c


DescriptionLookup to the Contact object if the record originates from a contact relationship.

Typereference

RelatedUser__c


DescriptionLookup to the User object if the record originates from a user.

TimelineViewConfiguration__cRepresents an event type on the timeline view in the patient care console.


Fields

DetailsField

Typeboolean

Active__c


DescriptionIndicates whether this field appears on the timeline.

352

TimelineViewConfiguration__cHealth Cloud Developer Guide

DetailsField

Typemultipicklist

Configuration_Target__c

PropertiesCreate, Filter, Nillable, Restricted Picklist, Sort, Update

DescriptionPicklist used to select which timelines the record targets. You can create one configurationrecord for patient communities and one for the Health Cloud console. To show the samefields in both the Health Cloud console and the community, select both options.

Typestring

DetailField__c


DescriptionInformation from this field appears in the hover view on the timeline.

Typereference

FilterCriterion__c


DescriptionThe name of the collection of filters that apply to this configuration.

Typestring

FriendlyName__c


DescriptionThe human-readable name of the timeline view configuration.

Typestring

GraphicalIcon__c


DescriptionThe icon used to depict the event on the timeline.

Typestring

HoverFieldName__c


353


DetailsField

DescriptionEnter up to seven comma-separated field names from the object you want to display. Thevalues from this field appear as hover Hover Field Name text for an event on the timeline.For example, you can display fields like the due date, performer name, status, and the relatedproblem for tasks. Make sure to use the API field name and not the field label. Valid fieldtypes are Date, Combobox, Number, Picklist, and Text.

TypedateTime

LastReferencedDate__c



Typestring

LanguageCode__c


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.

TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the timeline view configuration. Limit: 255 characters.

354


DetailsField

Typestring

ObjectCategory__c


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



Typestring

PatientAccountLookup__c


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, 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

PositionField__c


DescriptionThe date or datetime field that the system uses to position the event horizontally on thecorrect date on the timeline.

Typeboolean

ShowOnLoad__c


DescriptionControls the option to only show a subset of events when the timeline first appears in theconsole.

355


DetailsField

Typedouble

SortOrder__c


DescriptionIndicates the vertical order that the events appear when there are other events with thesame date on the timeline.

Health Cloud Custom Metadata Types

Custom metadata is customizable, deployable, packageable, and upgradeable application metadata.

GroupRecordTypeMapperMaps 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


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


DescriptionNamespace for Account record type being mapped.

356

Health Cloud Custom Metadata TypesHealth Cloud Developer Guide

IndividualRecordTypeMapperMaps a new custom Individual record type to the standard Individual record type from Financial Services Cloud.


Supported CallsdescribeLayout(), describeSObjects(), query(), retrieve(), search()

DetailsField

Typestring

AccountRecordTypeNamespace__c


DescriptionNamespace for Account record type being mapped.

Typestring

AccountRecordType__c


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


DescriptionNamespace for Contact record type being mapped.

Typestring

ContactRecordType__c


DescriptionContact record type being mapped to the Financial Services Cloud Individual record type.

Typestring

DetailPage__c

357

IndividualRecordTypeMapperHealth Cloud Developer Guide

DetailsField


DescriptionSalesforce internal-use only.

Typestring

IndividualType__c


DescriptionType of Individual being mapped.

Typestring

LeadRecordTypeNamespace__c


DescriptionLead namespace for your custom record type’s org.

Typestring

LeadRecordType__c


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.

RiskScoreAgeBandContinuedEnrolleeMapping used to indicate risk score based on age and continued enrollment status.


Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typedouble

AgeBandFrom__c

358

RiskScoreAgeBandContinuedEnrolleeHealth Cloud Developer Guide

DetailsField

PropertiesFilter, Sort

DescriptionMinimum age in a defined group.

Typedouble

AgeBandTo__c


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


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


DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.

Typedouble

CommunityNonDualDisabled__c


359


DetailsField

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.

Typedouble

CommunityPBDualAged__c


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


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


DescriptionIndicates that the patient lives at home.

Typepicklist

Gender__c

PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort


Typedouble

Institutional__c


DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.

360


DetailsField

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.

RiskScoreAgeBandNewEnrolleeMapping used to indicate risk score based on age and new enrollment status.



DetailsField

Typedouble

AgeBandFrom__c


DescriptionMinimum age in a defined group.

Typedouble

AgeBandTo__c


DescriptionMaximum age in a defined group.

Typeboolean

CSNP__c

361

RiskScoreAgeBandNewEnrolleeHealth Cloud Developer Guide

DetailsField


DescriptionWhether the patient is part of a CSNP (Chronic Condition Special Needs Plan).

Typepicklist

Gender__c

PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort


Typeboolean

IsActive__c



Typedouble

MedicaidNonOriginallyDisabled__c


DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.

Typedouble

MedicaidOriginallyDisabled__c


DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas due to disability.

Typedouble

NonMedicaidNonOriginallyDisabled__c


DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.

362

RiskScoreAgeBandNewEnrolleeHealth Cloud Developer Guide

DetailsField

Typedouble

NonMedicaidOriginallyDisabled__c


DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas due to disability.

Typestring

YearSpan__c



RiskScoreHCCCodeMaps risk score to HCC codes.



DetailsField

Typedouble

Community__c



Typedouble




363

RiskScoreHCCCodeHealth Cloud Developer Guide

DetailsField

Typedouble




Typedouble



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.

Typedouble



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.

Typedouble



Description

Typedouble



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


364


DetailsField

DescriptionIndicates the medical condition category that the HCC belongs to.

Typestring

Description__c


DescriptionDescription of the medical condition category.

Typestring

HCCCode__c


DescriptionThe HCC code related to the condition.

Typedouble

Institutional__c



Typeboolean

IsActive__c



Typestring

OverriddenHCCCodes__c


DescriptionIndicates which HHC codes are overridden by the value in HCCCode__c.

Typestring

YearSpan__c


365


DetailsField


RiskScoreDiseaseInteractionMaps risk scores to disease interactions.



DetailsField

Typeboolean

ApplyIfDisabled__c


DescriptionIndicates a disabled-disease interaction instead of a disease-disease interaction.

Typedouble

Community__c



Typedouble




Typedouble



366

RiskScoreDiseaseInteractionHealth Cloud Developer Guide

DetailsField


Typedouble



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.

Typedouble



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.

Typedouble



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




Typestring

HasConditions__c


367

RiskScoreDiseaseInteractionHealth Cloud Developer Guide

DetailsField

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



Typestring

InteractingConditions__c


DescriptionIndicates conditions that interact with the conditions found in HasConditions__c basedon disease-disease interactions.

Typeboolean

IsActive__c



Typestring

YearSpan__c



RiskScoreMedicaidInteractionsMaps risk scores to Medicaid and originally disabled interactions.



368

RiskScoreMedicaidInteractionsHealth Cloud Developer Guide

DetailsField

Typedouble

Community__c1



Typedouble



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



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



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.

Typedouble



DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.

Typedouble


369


DetailsField


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




Typeboolean

Disabled__c


DescriptionPatient is disabled.

Typepicklist

Gender__c

PropertiesDefaulted on create, Filter, Group, Nillable, Restricted picklist, Sort


Typedouble

Institutional__c



Typeboolean

IsActive__c



370


DetailsField

Typeboolean

Medicaid__c


DescriptionIs eligible for Medicaid.

Typeboolean

OriginallyDisabled__c


DescriptionOriginal reason for Medicare entitlement. Picklist values: Age and disabled.

Typestring

YearSpan__c



HealthCloudSettingHolds 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.



DetailsField

Typeboolean

Active__c


DescriptionIndicates whether the record is active.

371

HealthCloudSettingHealth Cloud Developer Guide

DetailsField

Typestring

SettingName__c


DescriptionName of the configuration setting or value that is mapped.

Typestring

SettingValue__c


DescriptionConfiguration value for a particular setting.

Storing HL7 Data in Salesforce Objects

HL7 (Health Level Seven) is a standard for exchanging electronic health records (EHR). We have mapped some of the key HL7 dataelements to the health cloud data model in this section.

Note: Elements that aren't mapped here are not yet supported. We will continue to add to these mappings.

Storing HL7 Admission, Discharge, Transfer (ADT) Data in Salesforce ObjectsThe HL7 Admission, Discharge, Transfer (ADT) message handles information such as the identity of the patient, the patient’s next of kin,patient visits, payers, and allergies. Data elements in ADT messages are stored in the Salesforce Account and Contact objects and inHealth Cloud custom objects. Elements are listed here in order of sequence number in the HL7 standard.

ADT Patient Identification (PID)Patient Identification (PID) elements in ADT messages handle information needed for establishing the identity of the patient.

FieldSalesforce ObjectHL7 ElementSEQ

Set ID – Patient ID1

Medical Record Number(HealthCloudGA__MedicalRecordNumber__c)

AccountPatient ID (External ID)2

Source System; IDAccountPatient ID (Internal ID)3

Account NameAccountPatient Name5

Contact NameContact

Given Name1; Family Name1EHR Patient

372

Storing HL7 Data in Salesforce ObjectsHealth Cloud Developer Guide


Date of BirthContactDate/Time of Birth7

Birth DateEHR Patient

Gender Code; Gender LabelEHR PatientSex8

Given Name2; Family Name2EHR PatientPatient Alias9



Address Information: Mailing Street, Mailing City,Mailing State, Mailing Zip/ Postal Code, MailingCountry

ContactPatient Address11

Address1Line1, Address1Line2, Address1 City, Address1 Country, Address1 Postal Code, Address 1 StateDate, Address 1 End Date

EHR Patient

HomePhoneContactPhone Number – Home13

PhoneContactPhone Number – Business14

HealthCloudGA__PrimaryLanguage__cContactPrimary Language15

HealthCloudGA__PrimaryLanguage__cAccount

Communication1Code__c (1 to 5)EHR Patient

HealthCloudGA__MaritalStatusCode__c,HealthCloudGA__MaritalStatusLabel__c

Candidate PatientMarital Status16

HealthCloudGA__MaritalStatusCode__c,HealthCloudGA__MaritalStatusLabel__c

EHR Patient

HealthCloudGA__Deceased__cCandidate PatientPatient Death Indicator30

HealthCloudGA__Deceased__cEHR Patient

ADT Next of Kin (NK1)The NK1 segment contains information about the patient’s other related parties, and any associated parties.


Set ID - NK1NK1.1

Contact NameContactNK NameNK1.2

Account NameAccount

Given Name1 (up to 5); Family Name1 (up to 3)EHR Patient RelatedPerson

373

Storing HL7 Admission, Discharge, Transfer (ADT) Data inSalesforce Objects

Health Cloud Developer Guide


Related RoleContact ContactRelationship

RelationshipNK1.3

RelationshipEHR Patient RelatedPerson


ContactAddressNK1.4

Address Information: Address1 Line1, Address1 Line2,Address1 City, Address1 State, Address1 Postal Code,Address1 Country

EHR Patient RelatedPerson

Phone, Home Phone, MobileContactPhone NumberNK1.5

Telecom1 Value(up to 5)EHR Patient RelatedPerson

Phone, Other PhoneContactBusiness Phone NumberNK1.6

Telecom1 Value(up to 5)EHR Patient RelatedPerson

Role, Role 255EHR Patient RelatedPerson

Contact RoleNK1.7

TitleContactNext of Kin / Associated Parties Job TitleNK1.10

NK1.11

Employee NumberUserNext of Kin / Associated PartiesEmployee Number

NK1.12

GenderAccountSexNK1.15

GenderContact

GenderEHR Patient RelatedPerson

HealthCloudGA__BirthDate__c_AccountDate/Time Of BirthNK1.16

HealthCloudGA__BirthDate__c_Contact

HealthCloudGA__BirthDate__c_EHR Patient RelatedPerson

HealthCloudGA__PrimaryLanguage__pcAccountPrimary LanguageNK1.20

HealthCloudGA__PrimaryLanguage__cContact

HealthCloudGA__Language1__c (from 1 to 5)EHR Patient RelatedPerson

Given Name1 (up to 5); Family Name1 (up to 3)EHR Patient ContactContact Person’s NameNK1.30

374




Telecom1 Value (up to 5)EHR Patient ContactContact Person’s Telephone NumberNK1.31

Address Information: Address1 Line1, Address1 Line2,Address1 City, Address1 State, Address1 Postal Code,Address1 Country

EHR Patient ContactContact Person’s AddressNK1.32

ADT Patient Visit (PV1)The PV1 segment contains information about inpatient or outpatient health care encounters.


Class__cEhrEncounterPatient Class2

Location1Description__c, Location1Name__c,Location1Type__c

EhrEncounterAssigned Patient Location3

Indication__c, ReasonCode__c, ReasonLabel__cEhrEncounterAdmission Type4

HealthCloudGA__HospitalizePreAdmissionId__c,HealthCloudGA__HospitalizationPreAdmissionId__c,HealthCloudGA__HospitalizeAdmitSourceCode__c

EhrEncounterPreadmit Number5

HospitalizeOrigin__c, HospitalizationOrigin__cEhrEncounterPrior Patient Location6

Practitioner__cEhrEncounterParticipant__cAttending Doctor7

TypeCode__c, TypeLabel__cEhrEncounterParticipant__c

HospitalizeAdmitSourceCode__c,HospitalAdmitSourceLabel__c

EhrEncounterReferring Doctor8

Practitioner__cEhrEncounterParticipant__cConsulting Doctor9


TypeCode__c, TypeLabel__cEhrEncounterHospital Service10

HospitalizeReadmission__cEhrEncounterRe-admission Indicator13

Practitioner__cEhrEncounterParticipant__cAdmitting Doctor17


HospitalizeDischargeDispositionCode__cEhrEncounterDischarge Disposition36

HospitalizeDestination__cEhrEncounterDischarged to Location37

HospitalizeDietCode__c, HospitalizeDietLabel__cEhrEncounterDiet Type38


EhrEncounterPending Location42


EhrEncounterPrior Temporary Location43

375




HospitalizePeriodStart__cEhrEncounterAdmit Date/Time44

HospitalizePeriodEnd__cEhrEncounterDischarge Date/Time45

ADT Guarantor (GT1)The GT1 segment contains data about the guarantor (e.g., the person or the organization with financial responsibility for payment of apatient account) for patient and insurance billing applications.


HealthCloudGA__IndividualId__cContactGuarantor Number2

HealthCloudGA__IndividualId__cAccount

Contact NameContactGuarantor Name3


ContactGuarantor Address5

HomePhoneContactGuarantor Ph Num-Home6

PhoneContactGuarantor Ph Num-Business7

HealthCloudGA__BirthDate__cContactGuarantor Date/Time Of Birth8

HealthCloudGA__Gender__cContactGuarantor Sex9

HealthCloudGA__IndividualType__cContactGuarantor Type10

Related RoleContact Contact RelationsGuarantor Relationship11

HealthCloudGA__StartDate__cContact Contact RelationsGuarantor Date - Begin13

HealthCloudGA__EndDate__cContact Contact RelationsGuarantor Date - End14

NameAccountGuarantor Organization Name21

HealthCloudGA__PrimaryLanguage__cContactPrimary Language36

ADT Allergies (AL1)The AL1 segment contains patient allergy information. Most of this information will be derived from user-defined tables. Each AL1segment describes a single patient allergy.


SensitivityTypeCode__c, SensitivityTypeLabel__c,SensitivityTypeSystem__c

EhrAllergyIntolerance__cAllergen Type Code2

Substance255__c, SubstanceLong__cEhrAllergyIntolerance__cAllergen Code/Mnemonic/Description3

376




CriticalityCode__c, CriticalityLabel__c,CriticalitySystem__c

EhrAllergyIntolerance__cAllergy Severity Code4

Reaction255__c, Reaction__cEhrAllergyIntolerance__cAllergy Reaction Code5

RecordedDate__cEhrAllergyIntolerance__cIdentification Date6

Storing HL7 Clinical Document Architecture (CDA) Data in Salesforce ObjectsClinical Document Architecture (CDA) is a document markup standard that specifies the structure and semantics of clinical documentsfor the purpose of exchange between health care providers and patients.

CDA Target Patient

FieldSalesforce ObjectExampleCDA Entry

GivenName1__cEhrPatient__cJaneName: Given Name

FamilyName1__cEhrPatient__cAppleseed-MonroeName: Family Name

Account NameAccount

Contact NameContact

123-456-7890SSN

Date of BirthAccount19770330Birth Time (date)

BirthDate__cEhrPatient__c

GenderCode__cEhrPatient__cFGender: Code

GenderLabel__cEhrPatient__cFemaleGender: Display Name

GenderSystem__cEhrPatient__cAdministrativeGender(2.16.840.1.113883.5.1)

Gender: Code System

HealthCloudGA__MaritalStatusCode__cEhrPatient__cMMarital Status: Code

HealthCloudGA__MaritalStatusLabel__cEhrPatient__cMarriedMarital Status: Display Name

Communication1Code__c (1 to 5)EhrPatient__cenLanguage: Code

Communication1Label__c (1 to 5)EhrPatient__cEnglishLanguage: Display Name

HealthCloudGA__PrimaryLanguage__cContact

HealthCloudGA__PrimaryLanguage__cAccount

Communication1System__c (1 to 5)EhrPatient__cLanguageCode(2.16.840.1.113883.1.11.11526)

Language: Code System

Address1Line1__cEhrPatient__c999 Huckleberry Ave, Apt #3Street Address: Line 1

Address Information: Mailing StreetContact

377

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects



Address1Line2__cEhrPatient__cStreet Address: Line 2

Address1City__cEhrPatient__cSpringfieldStreet Address: City

Mailing CityContact

Address1State__cEhrPatient__cPAStreet Address: State

Mailing StateContact

Address1PostalCode__cEhrPatient__c19604Street Address: Postal Code

Mailing Zip/ Postal CodeContact

Address1Country__cEhrPatient__cUSStreet Address: Country

Mailing CountryContact

Telecom1Use__c, Telecom1Value__cEhrPatient__c1(610)555-0000Home Telephone

HomePhoneContact

Telecom2Use__c, Telecom2Value__cEhrPatient__c1(610)555-1111Mobile Telephone

PhoneContact

CDA Conditions


HealthCloudGA__DateAsserted__cEhrCondition__c1/22/2011Effective Time: Low Value

1/31/2011Effective Time: High Value

HealthCloudGA__Notes__cEhrCondition__cSleep Apnea; Patientexperiencing flu symptomsincluding chills and fever

Narrative Description

HealthCloudGA__CategoryCode__cEhrCondition__c6142004Condition: Code

HealthCloudGA__CatergoryLabel__cEhrCondition__cInfluenzaCondition: Display Name

HealthCloudGA__CategorySystem__cEhrCondition__cSNOMED CT(2.16.840.1.113883.6.96)

Condition: Code System

HealthCloudGA_EvidenceCode__cEhrCondition__c43724002Symptoms: Code

HealthCloudGA_EvidenceDetail__c,HealthCloudGA_EvidenceLabel__c

EhrCondition__cChillSymptoms: Display Name

HealthCloudGA_EvidenceSystem__cEhrCondition__cSNOMED CT(2.16.840.1.113883.6.96)

Symptoms: Code System

378



CDA Medications

Note: This section can repeat for multiple medications. EHR Dosage Instruction object is a child object to EHR MedicationPrescription, which contains Dose, Route and Frequency.


HealthCloudGA__DateWritten__cEhrMedicationPrescription__c20070312Effective Time: LowValue (Date)

HealthCloudGA__StatusCode__c,HealthCloudGA__StatusLabel__c,HealthCloudGA__StatusSystem__c

EhrMedicationPrescription__cactiveStatus Code

HealthCloudGA__Instruction__c,HealthCloudGA__SupplementalInstruction__c

EhrDosageInstruction__cTake Acetaminophen 500 MGOral Tablet every 8 hours for 10days; Take Fluoxetine 15 MG OralTablet once a day at breakfast.

Narrative Text

HealthCloudGA__DispenseMedicationCode__c,HealthCloudGA__MedicationCode__c

EhrMedicationPrescription__c198440MedicationInformation: Code

HealthCloudGA__DispenseMedicationLabel__c,HealthCloudGA__MedicationCodeLabel__c

EhrMedicationPrescription__cAcetaminophen 500 MG OralTablet

MedicationInformation: DisplayName

HealthCloudGA__DispenseMedicationCodeSystem__c,HealthCloudGA__MedicationCodeSystem__c

EhrMedicationPrescription__cRxNorm (2.16.840.1.113883.6.88)MedicationInformation: CodeSystem

HealthCloudGA__RouteCode__cEhrDosageInstruction__cC38288Route ofAdministration: Code

HealthCloudGA__RouteLabel__cEhrDosageInstruction__cOralRoute ofAdministration:Display Name

HealthCloudGA__RouteSystem__cEhrDosageInstruction__cNCI Thesaurus(2.16.840.1.113883.3.26.1.1)

Route ofAdministration: CodeSystem

HealthCloudGA__DoseQuantityUnit__c,HealthCloudGA__DoseQuantityValue__c

EhrDosageInstruction__cDose Quantity

HealthCloudGA__DispenseMedicationProductFormCode__cEhrMedicationPrescription__cC42998Product Form: Code

HealthCloudGA__DispenseMedicationProductFormLabel__cEhrMedicationPrescription__cTabletProduct Form:Display Name

HealthCloudGA__DispenseMedicationProductFormSystem__cEhrMedicationPrescription__cNCI Thesaurus(2.16.840.1.113883.3.26.1.1)

Product Form: CodeSystem

379



CDA Allergies


RecordedDate__cEhrAllergyIntolerance__c20070312Effective Time: Low Value (Date)

HealthCloudGA__StatusCode__c,HealthCloudGA__StatusLabel__c,HealthCloudGA__StatusSystem__c

EhrAllergyIntolerance__ccompletedStatus Code

HealthCloudGA__Reaction__cEhrAllergyIntolerance__cPatient relays that theyexperienced erythema of skin

Narrative Text

after taking sulfa drug and wastold to never take it again;Patient has allergy to soybean,Experienced swelling of thetongue as a child and has beeninstructed to avoid soybean.

HealthCloudGA__SensitivityTypeCode__cEhrAllergyIntolerance__c416098002Type of Allergy: Code

HealthCloudGA__SensitivityTypeLabel__cEhrAllergyIntolerance__cdrug allergyType of Allergy: Display Name

HealthCloudGA__SensitivityTypeSystem__cEhrAllergyIntolerance__cSNOMED CT(2.16.840.1.113883.6.96)

Type of Allergy: Code: CodeSystem

SubstanceCode__c (New in Spring '18)EhrAllergyIntolerance__c10180Drug: Code

HealthCloudGA__Substance255__cEhrAllergyIntolerance__cSulfamethoxazoleDrug: Display Name

SubstanceCodeSystem__c (New in Spring'18)

EhrAllergyIntolerance__cRxNorm (2.16.840.1.113883.6.88)Drug: Code System

No equivalent in Health Cloud444827008Reaction: Code

HealthCloudGA__Reaction255__cEhrAllergyIntolerance__cErythema of skinReaction: Display Name

No equivalent in Health CloudSNOMED CT(2.16.840.1.113883.6.96)

Reaction: Code System

HealthCloudGA__CriticalityCode__cEhrAllergyIntolerance__c6736007Severity: Code

HealthCloudGA__CriticalityLabel__cEhrAllergyIntolerance__cModerateSeverity: Display Name

HealthCloudGA__CriticalitySystem__cEhrAllergyIntolerance__cSNOMED CT(2.16.840.1.113883.6.96)

Severity: Code System

CDA Immunizations


HealthCloudGA__DateAdministered__cEhrImmunization__c20070312Effective Time (VaccineDate)

HealthCloudGA__VaccineTypeCode__cEhrImmunization__c33Vaccine Code

380




HealthCloudGA__VaccineTypeLabel__cEhrImmunization__cPneumococcal (PCV, PPSV)Vaccine DisplayName

HealthCloudGA__VaccineTypeSystem__cEhrImmunization__cCVX (2.16.840.1.113883.12.292)Vaccine Code System

CompletedStatus Code

HealthCloudGA__DoseQuantityUnits__cEhrImmunization__cmLDose Quantity: Unit

HealthCloudGA__DoseQuantityValue__cEhrImmunization__c2Dose Quantity: Value

HealthCloudGA__LotNumber__cEhrImmunization__c3422Lot Number

CDA Plan of Care


HealthCloudGA__PeriodStart__cEHR Care Plan20070312Effective Time: Low Value (Date)

HealthCloudGA__PeriodEnd__cEHR Care PlanEffective Time: High Value (Date)

HealthCloudGA__Notes__cEHR Care Plan"Patient is to schedule CT scan toexamine knee; Follow-up

Narrative Text

appointment in 2 weeks; Patientwas supplied with Malarone250/100 Oral Tablet and shouldtake one every 24 hours during theirvisit to Africa to prevent Malaria;Patient instructed to take thismedication by mouth with food ora milky drink (such as whole milk,milkshake) that contains fat. "

HealthCloudGA__Code__cEHR Procedure Request73700Procedure Code

HealthCloudGA__CodeLabel__cEHR Procedure RequestCT lower Extremity (Leg) w/ocontrast

Procedure Display Name

HealthCloudGA__OrderedOn__cEHR Procedure RequestRequested Date (Same as EffectiveTime: Low Value)

CDA Procedures and Practitioners


PerformedDateTime__cEhrProcedure__c201209011200Effective Time: Low Value (Date)

Notes__cEhrProcedure__cCath showed significant CAD,best treated medically.

Narrative Text

Code__cEhrProcedure__c93452Procedure: Code

381




CodeLabel__cEhrProcedure__cL HRT CATH W/NJX LVENTRICULOGRAPHY IMG S+I

Procedure: Display Name

PrefixName1__c (EHR Procedure and EHRPractitioner objects are connected via theEHR Procedure Performer Object)

EhrPractitioner__cDrPractitioner: Prefix

GivenName1__cEhrPractitioner__cJeffereyPractitioner: Given

GivenName1__cEhrPractitioner__cQPractitioner: Given

FamilyName1__cEhrPractitioner__cSmithPractitioner: Family

SuffixName1__cEhrPractitioner__cMDPractitioner: Suffix

Address1Line1__cEhrPractitioner__c877 E St NWPractitioner: Street Address Line1

Address1Line2__cEhrPractitioner__cPractitioner: Street Address Line2

Address1City__cEhrPractitioner__cSpringfieldPractitioner: City

Address1State__cEhrPractitioner__cOHPractitioner: State

Address1PostalCode__cEhrPractitioner__c45503Practitioner: Postal Code

Address1Country__cEhrPractitioner__cUSPractitioner: Country

Telecom1System__c, Telecom1Use__c,Telecom1Value__c

EhrPractitioner__c1(937)555-0122Practitioner: Telephone Number

Location1Name__cEhrPractitioner__cHappy Heart AssociatesPractioner Organization:Name

Location1TelecomSystem__c,Location1TelecomUse__c,Location1TelecomValue__c

EhrPractitioner__c1(937)555-0199Practioner Organization:Telephone Number

Location1Line1__cEhrPractitioner__c100 Cardio LanePractioner Organization: StreetAddress Line 1

Location1Line2__cEhrPractitioner__cPractioner Organization: StreetAddress Line 2

Location1City__cEhrPractitioner__cSpringfieldPractioner Organization: City

Location1State__cEhrPractitioner__cOHPractioner Organization: State

Location1PostalCode__cEhrPractitioner__c45503Practioner Organization: PostalCode

Location1Country__cEhrPractitioner__cUSPractioner Organization: Country

1005-8Facility: Code

Location__cEhrProcedure__cCardiac Catheterization LabFacility: Display Name

382



CDA Lab Results


HealthCloudGA__AppliesDateTime__cEhrObservation__c20110914Effective Time (Date)

HealthCloudGA__StatusCode__cEhrObservation__cCompletedStatus Code

HealthCloudGA__ValueLabel__cEhrObservation__c"Cholesterol - 176 mg/dL(normal) Triglyceride - 100

Narrative Text

mg/dL (normal) HDL - 60 mg/dL(normal) LDL - 116 mg/dL(normal)"

HealthCloudGA__MethodCode__cEhrObservation__c2093-3Observation Code

HealthCloudGA__MethodLabel__cEhrObservation__cCholesterol [Mass/volume] inSerum or Plasma

Observation Display Name

HealthCloudGA__MethodSystem__cEhrObservation__cLOINC (2.16.840.1.113883.6.1)Observation Code System

HealthCloudGA__ValueQuantity__cEhrObservation__c176Observed Value (Result): Value

HealthCloudGA__ValueQuantityUnit__cEhrObservation__cmg/DLObserved Value (Result): Unit

HealthCloudGA__InterpretationCode__cEhrObservation__cNInterpretation Code: Code

HealthCloudGA__InterpretationLabel__cEhrObservation__cNormalInterpretation Code: DisplayName

HealthCloudGA__InterpretationSystem__cEhrObservation__cObservationInterpretation(2.16.840.1.113883.5.83)

Interpretation Code: CodeSystem

HealthCloudGA__ReferenceRangeHighValue__c,HealthCloudGA__ReferenceRangeHighUnit__c,

EhrObservation__cRecommended: 0-199; ModerateRisk: 200-239; High Risk: 240+

Reference Range

HealthCloudGA__ReferenceRangeLowValue__c,HealthCloudGA__ReferenceRangeLowUnit__c

Storing HL7 Observation Results (ORU) Data in Salesforce ObjectsThe ORU message transmits observations and results from the producing system (such as an EKG or MRI system) to the ordering system(such as a physician's office).

Note: These mappings build on the mappings specified for the in the ADT message for the common segments.

ORU Order (ORC)The Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that are requested).

FieldSalesforce ObjectORC ElementSeq

SourceSystem__c, SourceSystemID__cEHRProcedure__cPlacer Order Number2

SourceSystem__c, SourceSystemId__cEhrObservation__cFiller Order Number3

383

Storing HL7 Observation Results (ORU) Data in SalesforceObjects


FieldSalesforce ObjectORC ElementSeq

StatusEHRProcedure__cOrder Status5

StatusEHRProcedureRequest__c

HealthCloudGA__PerformedDateTime__cEHRProcedure__cDate/Time of Transaction9

HealthCloudGA__ScheduledDateTime__cEHRProcedureRequest__c

HealthCloudGA__OrderedBy__cEHRProcedureRequest__cOrdering Provider12

HealthCloudGA__Location__cEHRProcedure__cEnterer's Location13

Location__cEhrProcedure__cOrdering Facility Name21

ORU Observation Request (OBR)In the reporting of clinical data, the OBR serves as the report header. It identifies the observation set represented by a series of atomicobservations.

FieldSalesforce ObjectHL7 ElementSeq

SourceSystem__c, SourceSystemID__cEHRProcedure__cPlacer Order Number2

SourceSystem__c, SourceSystemId__cEhrObservation__cFiller Order Number3

Code__c, odeLabel__cEhrProcedure__cUniversal Service Identifier4

OrderedOn__cEHRProcedureRequest__cRequested Date/Time6

PerformedDateTime__cEhrProcedure__cObservation Date/Time7

AppliesDateTime__cEhrObservation__c

No specific field, but can be mapped to EhrConditionHealthCloudGA__EhrCondition__cRelevant ClinicalInformation

13

PerformedDateTime__cEhrProcedure__cSpecimen ReceivedDate/Time

14

AppliesDateTime__cEhrObservation__c

BodySiteCode__c, BodySiteLabel__c,BodySiteSystem__c

EhrObservation__cSpecimen Source15

OrderedBy__cEHRProcedureRequest__cOrdering Provider16

SourceSystemModified__cEhrProcedure__cResults Rpt/Status Chng -Date/Time

22

SourceSystemModified__cEhrObservation__c

HealthCloudGA__Status__c,HealthCloudGA__StatusCode__c

HealthCloudGA__EhrObservation__cResult Status25

HealthCloudGA__Practitioner__cHealthCloudGA__EhrObservation__cPrincipal Result Interpreter32

HealthCloudGA__Comments__cHealthCloudGA__EhrObservation__cCollector's Comment *39

384



OBR Note


Notes__cEHRProcedure__cComment3

ORU Observation (OBX)The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a report.


HealthCloudGA__MethodCode__c,HealthCloudGA__MethodLabel__c,HealthCloudGA__MethodSystem__c

EhrObservation__cObservation Identifier3

HealthCloudGA__ValueLabel__c,HealthCloudGA__ValueQuantity__c

HealthCloudGA__EhrObservation__cObservation Value5

HealthCloudGA__ValueQuantityUnit__cHealthCloudGA__EhrObservation__cUnits6

HealthCloudGA__ReferenceRangeHighValue__c,HealthCloudGA__ReferenceRangeHighUnit__c,

HealthCloudGA__EhrObservation__cReferences Range7

HealthCloudGA__ReferenceRangeLowValue__c,HealthCloudGA__ReferenceRangeLowUnit__c

HealthCloudGA__EhrObservation__c

HealthCloudGA__InterpretationCode__c,HealthCloudGA__InterpretationLabel__c,HealthCloudGA__InterpretationSystem__c

HealthCloudGA__EhrObservation__cAbnormal Flags8

HealthCloudGA__Status__c,HealthCloudGA__StatusCode__c

HealthCloudGA__EhrObservation__cObservation Result Status11

HealthCloudGA__AppliesDateTime__cHealthCloudGA__EhrObservation__cDate/Time of theObservation

14

HealthCloudGA__Practitioner__cHealthCloudGA__EhrObservation__cResponsible Observer16

HealthCloudGA__MethodCode__c,HealthCloudGA__MethodLabel__c

HealthCloudGA__EhrObservation__cObservation Method17

HealthCloudGA__Device__cHealthCloudGA__EhrObservation__cEquipment InstanceIdentifier

18

Potentially mapped through Performing Practitioner/address on EHR Practitioner

Performing OrganizationMedical Director

25

OBX Note


HealthCloudGA__Comments__cHealthCloudGA__EhrObservation__cComment3

385



health cloud object reference guide · pdf file• egypt • el salvador • ......

Documents