Service​Request

The service​Request FH​IR resource maps to the Clinical​Service​Request and Clinical​Service​Request​Detail objects in Salesforce​.

FH​IR V4​.0 - Clinical​ Data Model Mapping 

Here’s how the fields defined by FH​IR for service​Request map to the fields in Salesforce​.

Service ​Request ResourceSalesforce FieldTypeSalesforce CardinalityNotes
identifier​IdentifierObject0​.MThe identifier information for a service request is represented as ​Identifier records that reference the Clinical​Service​Request record using their ​Identifier​.Parent​​Record​Id field​.
instantiates​Canonical​N/AN/AN/ANot Supported
instantiates​Canonical​N/AN/AN/ANot Supported
basedOnClinical​Service​Request​DetailObject0​.MThe information about the service request or medication request that a service request is based on is represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.
The Salesforce implementation of service​Request​.basedOn doesn’t support references to care plans​.
basedOnClinical​Service​Request​Detail​.​Detail​Record​IdPolymorphic Lookup: Clinical​Service​Request, Medication​Request0​.1For service​Request​.basedOn information, Clinical​Service​Request​Detail​.​Detail​Record​Id must reference a Clinical​Service​Request or Medication​Request record​.
basedOnClinical​Service​Request​Detail​.​Detail​TypePicklist
Value: Based On
0​.1For service​Request​.basedOn information, Clinical​Service​Request​Detail​.​DetailType must use the value Based On​.
replacesClinical​Service​Request​.Original​Request​IdLookup: Clinical​Service​Request0​.1While FH​IR defines service​Request​.replaces as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
requisitionClinical​Service​Request​.Service​Request​Group​Identifier​IdLookup: ​Identifier0​.1N/A
statusClinical​Service​Request​.StatusPicklist1​.1While FH​IR defines service​Request​.status as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Status is picklist​.
intentClinical​Service​Request​.TypePicklist1​.1While FH​IR defines service​Request​.intent as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Type is picklist​.
categoryClinical​Service​Request​.Category​IdLookup: CodeSet​Bundle0​.1N/A
priorityClinical​Service​Request​.PriorityPicklist0​.1While FH​IR defines service​Request​.priority as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Priority is picklist​.
doNot​PerformClinical​Service​Request​.​Is​IgnoredBoolean0​.1N/A
codeClinical​Service​Request​.​Request​Code​IdLookup: CodeSet​Bundle0​.1N/A
order​DetailN/AN/AN/ANot Supported
quantity​.quantity​QuantityClinical​Service​Request​.Quantity​NumeratorDouble0​.1Because Salesforce doesn’t support a native quantity data type, the implementation of service​Request​.quantity​.quantity​Quantity is flattened into a set of quantity and unit fields​.
quantity​.quantity​QuantityClinical​Service​Request​.Quantity​Numerator​Unit​IdLookup: UnitOf​Measure0​.1Because Salesforce doesn’t support a native quantity data type, the implementation of service​Request​.quantity​.quantity​Quantity is flattened into a set of quantity and unit fields​.
quantity​.quantity​RatioClinical​Service​Request​.Quantity​NumeratorDouble0​.1Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RatioClinical​Service​Request​.Quantity​DenominatorDouble0​.1Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RatioClinical​Service​Request​.Quantity​Numerator​Unit​IdLookup: UnitOf​Measure0​.1Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RatioClinical​Service​Request​.Quantity​TypePicklist
Value: Ratio
0​.1For service​Request​.quantity​.quantity​Ratio information, Clinical​Service​Request​.Quantity​Type must use the value Ratio​.
quantity​.quantity​RangeClinical​Service​Request​.Quantity​NumeratorDouble0​.1Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RangeClinical​Service​Request​.Quantity​DenominatorDouble0​.1Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RangeClinical​Service​Request​.Quantity​Numerator​Unit​IdLookup: UnitOf​Measure0​.1Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​RangeClinical​Service​Request​.Quantity​TypePicklist
Value: Range
0​.1For service​Request​.quantity​.quantity​Range information, Clinical​Service​Request​.Quantity​Type must use the value Range​.
subjectClinical​Service​Request​.Patient​IdMaster-​Detail Reference: Account1​.1Only references to patients are supported​.
encounterClinical​Service​Request​.Clinical​Encounter​IdLookup: Clinical​Encounter0​.1N/A
occurrence​.occurrence​Date​TimeClinical​Service​Request​.Start​Date​Date​Time0​.1Clinical​Service​Request​.StartDate is used for both service​Request​.occurrence​.occurrence​Date​Time and service​Request​.occurrence​.occurrence​Period​. For the latter, the field is used to represent the start date of the period​.
occurrence​.occurrence​PeriodClinical​Service​Request​.Start​Date​Date​Time0​.1Because Salesforce doesn’t support a native period data type, the service​Request​.occurrence​.occurrence​Period is flattened into a set of start date and end date fields​.
occurrence​.occurrence​PeriodClinical​Service​Request​.End​Date​Date​Time0​.1Because Salesforce doesn’t support a native period data type, the service​Request​.occurrence​.occurrence​Period is flattened into a set of start date and end date fields​.
occurrence​.occurrence​TimingN/AN/AN/ANot supported
asNeeded​.asNeeded​BooleanClinical​Service​Request​.Has​PrerequisitesBoolean0​.1N/A
asNeeded​.asNeeded​Codeable​ConceptClinical​Service​Request​.Prerequisite​Code​IdLookup: CodeSet​Bundle0​.10​.1
authored​OnClinical​Service​Request​.Date​Signed​Date​Time0​.1N/A
requesterClinical​Service​Request​.​Requester​IdPolymorphic Lookup: Account, Asset, Care​Registered​Device, and Healthcare​Provider0​.1N/A
performer​TypeClinical​Service​Request​.Performer​Type​IdLookup: CodeSet​Bundle0​.1N/A
performerClinical​Service​Request​.Performer​IdPolymorphic Lookup: Account, Asset, Care​Registered​Device, and Healthcare​Provider0​.1References to care teams and healthcare services are not supported​.
While FH​IR defines service​Request​.performer as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
location​CodeClinical​Service​Request​.Facility​CodeIdLookup: CodeSet​Bundle0​.1While FH​IR defines service​Request​.location​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
location​ReferenceClinical​Service​Request​.Facility​IdLookup: Healthcare​Facility0​.1While FH​IR defines service​Request​.location​Reference as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​CodeClinical​Service​Request​.Reason​CodeIdLookup: CodeSet​Bundle0​.1While FH​IR defines service​Request​.reason​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​ReferenceClinical​Service​Request​.Diagnostic​ReportIdLookup: Diagnostic​Summary0​.1N/A
reason​ReferenceClinical​Service​Request​.Condition​IdLookup: Health​Condition0​.1To support zero-to-many values, use the child object instead.
reason​ReferenceClinical​Service​Request​.Observation​IdLookup: Care​Observation0​.1To support zero-to-many values, use the child object instead.
reason​ReferenceClinical​Service​Request​DetailObject0​.MThe records referencing the reasons for a service request are represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.
reason​ReferenceClinical​Service​Request​Detail​.​Detail​Record​IdPolymorphic Lookup: Health​Condition, Care​Observation, Diagnostic​Summary0​.1For service​Request​.reason​Reference information, Clinical​Service​Request​Detail​.​Detail​Record​Id must reference a Health​Condition or Care​Observation record​.
reason​ReferenceClinical​Service​Request​Detail​.​Detail​TypePicklist
Value: Reason Reference
0​.1For service​Request​.reason​Reference information, Clinical​Service​Request​Detail​.​Detail​Type must use the value Reason Reference​.
insuranceN/AN/AN/ANot supported
supporting​InfoN/AN/AN/ANot supported
specimenN/AN/AN/ANot supported
body​SiteClinical​Service​Request​DetailObject0​.MThe body site information of a service​Request is represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.
body​SiteClinical​Service​Request​Detail​.​Detail​CodeIdPolymorphic Lookup: CodeSet, CodeSet​Bundle0​.1For service​Request​.bodySite information, Clinical​Service​Request​Detail​.​Detail​CodeId must reference a CodeSet or CodeSet​Bundle record​.
body​SiteClinical​Service​Request​Detail​.​Detail​TypePicklist
Value: Body Site
0​.1For service​Request​.bodySite information, Clinical​Service​Request​Detail​.​Detail​Type must use the value Body Site​.
NoteN/AN/AN/ANot supported
patient​InstructionClinical​Service​Request​.Patient​InstructionText0​.1N/A
relevant​HistoryN/AN/AN/ANot supported

Sample Record Diagram 

Here’s a diagram that shows an example of how this resource is represented in Salesforce.

A diagram that shows how a service request for an x-ray for Charles is represented in Salesforce.

See Also