Health Cloud Clinical System API - Implementation Template

Clinical Dev Guide

The US-Core Clinical application uses the following DataWeave modules to map between HealthCloud and FHIR formats.

allergyintolerancefhirtools

allergyintolerancefhirtools DataWeave library contains functions used for converting HealthCloud data into FHIR format.

Source: .src/main/resources/dwl/AllergyIntolerance/allergyintolerancefhirtools.dwl

Functions

fun getAllergyIntoleranceResponse (allergyIntolerance)

Generates the FHIR response with the provided AllergyIntolerance Object.

param conditionRLU is the condition object to map.
return A HealthCloud AllergyIntolerance response.

fun getLinkSelf (attr: Object)

Gets the URL to the current web resource.

param attr is an object with the attributes.
return A string with the self link.

fun getEntryUrl (item: Object, attr: Object)

Gets the URL for the entry provided.

param item is an object with the item that's being returned.
param attr is an object with the attributes.
return A string with the entry URL.

(back to top)

allergyintoleranceRequest

This module defines functions needed to convert a
FHIR AllergyIntolerance resource into it's representation within
Health Cloud.

Source: .src/main/resources/dwl/AllergyIntolerance/allergyintoleranceRequest.dwl

Functions

fun getResultIds (res)

This function takes the results of a Salesforce query and returns a list of IDs.

param res is a Salesforce query result.
return An array with a list of Ids found.

fun getCodeSetUpsert (codeSetList)

Converts the provided AllergyIntolerance FHIR object to the HealthCloud CodeSet object.

param codeSetList is the list of codeSet object.
return HealthCloud CodeSet upsert fields.

fun getAllergyIntoleranceUpsert (fhirObj, codeSetBundleList)

Converts the provided AllergyIntolerance FHIR object to the HealthCloud AllergyIntolerance object.

param fhirObj is a FHIR AllergyIntolerance object.
param codeSetBundleList is the list of CodeSetBundle objects for the AllergyIntolerance object
return HealthCloud AllergyIntolerance upsert fields.

fun getAllergyIntoleranceUpdate (fhirObj, codeSetBundleList)

Converts the provided AllergyIntolerance FHIR object to the HealthCloud AllergyIntolerance object.

param fhirObj is a FHIR AllergyIntolerance object.
param codeSetBundleList is the list of CodeSetBundle objects for the AllergyIntolerance object
return HealthCloud AllergyIntolerance update fields.

fun getPatientHealthReactionUpsert (reactionFhirObj, allergyIntoleranceId, codeSetBundleList, rIndex)

Converts the provided AllergyIntolerance (Reaction) FHIR object to the HealthCloud PatientHealthReaction object.

param reactionFhirObj is a FHIR AllergyIntolerance (Reaction) object.
param codeSetBundleList is the list of CodeSetBundle objects for the AllergyIntoleranceReactions object
return HealthCloud PatientHealthReaction upsert fields.

fun getIdentifierUpsert (identifier, allergyIntoleranceId, typeId)

Converts the provided AllergyIntolerance FHIR object to the HealthCloud Identifier object.

param identifier is the list of Identifier object.
param allergyIntoleranceId is the associated allergyIntolerance Id
return HealthCloud Identifier upsert fields.

fun getCodeSetBundleUpsert (codeSetList, bundleType, name)

Converts the provided AllergyIntolerance FHIR object to the HealthCloud CodeSetBundle object.

param codeSetList is the list of CodeSetBundle object.
param bundleType is for defining the CodeSetBundle type.
param bundleType is for defining the name of the CodeSetBundle.
return HealthCloud CodeSetBundle upsert fields.

(back to top)

conditionfhirtools

conditionfhirtools DataWeave library contains functions used for converting HealthCloud data into FHIR format.

Source: .src/main/resources/dwl/Condition/conditionfhirtools.dwl

Functions

fun getConditionResponse (condition)

Generates the FHIR response with the provided Condition Object.

param conditionRLU is the condition object to map.
return A HealthCloud Condition response.

fun getLinkSelf (attr: Object)

Gets the URL to the current web resource.

param attr is an object with the attributes.
return A string with the self link.

fun getEntryUrl (item: Object, attr: Object)

Gets the URL for the entry provided.

param item is an object with the item that's being returned.
param attr is an object with the attributes.
return A string with the entry URL.

(back to top)

conditionRequest

This module defines functions needed to convert a
FHIR Condition resource into it's representation within
Health Cloud.

Source: .src/main/resources/dwl/Condition/conditionRequest.dwl

Functions

fun getResultIds (res)

This function takes the results of a Salesforce query and returns a list of IDs.

param res is a Salesforce query result.
return An array with a list of Ids found.

fun getCodeSetUpsert (codeSetList)

Converts the provided Condition FHIR object to the HealthCloud CodeSet object.

param codeSetList is the list of codeSet object.
return HealthCloud CodeSet upsert fields.

fun getConditionUpsert (fhirObj, codeSetBundleList)

Converts the provided Condition FHIR object to the HealthCloud Condition object.

param fhirObj is a FHIR Condition object.
param codeSetBundleList is the list of CodeSetBundle objects for the Condition object
return HealthCloud Condition upsert fields.

fun getConditionUpdate (fhirObj, codeSetBundleList)

Converts the provided Condition FHIR object to the HealthCloud Condition object.

param fhirObj is a FHIR Condition object.
param codeSetBundleList is the list of CodeSetBundle objects for the Condition object
return HealthCloud Condition update fields.

fun getIdentifierUpsert (identifier, conditionId, typeId)

Converts the provided Condition FHIR object to the HealthCloud Identifier object.

param identifier is the list of Identifier object.
param encounterId is the associated condition Id
return HealthCloud Identifier upsert fields.

fun getCodeSetBundleUpsert (codeSetList, bundleType, name)

Converts the provided Condition FHIR object to the HealthCloud CodeSetBundle object.

param codeSetList is the list of CodeSetBundle object.
param bundleType is for defining the CodeSetBundle type.
param name is for defining the name of the CodeSetBundle.
return HealthCloud CodeSetBundle upsert fields.

(back to top)

procedurefhirtools

procedurefhirtools DataWeave library contains functions used for converting HealthCloud data into FHIR format.

Source: .src/main/resources/dwl/Procedure/procedurefhirtools.dwl

Functions

fun getProcedureResponse (procedure)

Generates the FHIR response with the provided Encounter Object.

param procedure is the Procedure object to map.
return A HealthCloud Procedure response.

fun getLinkSelf (attr: Object)

Gets the URL to the current web resource.

param attr is an object with the attributes.
return A string with the self link.

fun getEntryUrl (item: Object, attr: Object)

Gets the URL for the entry provided.

param item is an object with the item that's being returned.
param attr is an object with the attributes.
return A string with the entry URL.

(back to top)

procedureRequest

This module defines functions needed to convert a
FHIR Procedure resource into it's representation within
Health Cloud.

Source: .src/main/resources/dwl/Procedure/procedureRequest.dwl

Functions

fun getResultIds (res)

This function takes the results of a Salesforce query and returns a list of IDs.

param res is a Salesforce query result.
return An array with a list of Ids found.

fun getCodeSetUpsert (codeSetList)

Converts the provided Procedure FHIR object to the HealthCloud CodeSet object.

param codeSetList is the list of codeSet object.
return HealthCloud CodeSet upsert fields.

fun getPatientMedicalProcedureUpsert (fhirObj, codeSetBundleList)

Converts the provided Procedure FHIR object to the HealthCloud PatientMedicalProcedure object.

param fhirObj is a FHIR Procedure object.
param codeSetBundleList is the list of CodeSetBundle objects for the Procedure object
return HealthCloud PatientMedicalProcedure upsert fields.

fun getPatientMedicalProcedureUpdate (fhirObj, codeSetBundleList)

Converts the provided Procedure FHIR object to the HealthCloud PatientMedicalProcedure object.

param fhirObj is a FHIR Procedure object.
param codeSetBundleList is the list of CodeSetBundle objects for the Procedure object
return HealthCloud PatientMedicalProcedure update fields.

fun getPatientMedicalProcedureDetailUpsert (procedureId, procedureDetail)

Converts the provided Procedure FHIR object to the HealthCloud PatientMedicalProcedureDetail object.

param procedureId is the associated Procedure Id
param procedureDetail is the list of Procedure Detail in Procedure FHIR object
return HealthCloud PatientMedicalProcedureDetails upsert fields.

fun getCarePerformerUpsert (procedureId, performer, codeSetBundleList)

Converts the provided Procedure FHIR object to the HealthCloud CarePerformer object.

param procedureId is the associated Procedure Id
param performer is Perfromer object of Procedure FHIR object
param codeSetBundleList is the list of CodeSetBundle objects for the Procedure object
return HealthCloud PatientMedicalProcedureDetails upsert fields.

fun getIdentifierUpsert (identifier, procedureId, typeId)

Converts the provided Procedure FHIR object to the HealthCloud Identifier object.

param identifier is the list of Identifier object.
param procedureId is the associated Procedure Id
param typeId is the codeSetId
return HealthCloud Identifier upsert fields.

fun getCodeSetBundleUpsert (codeSetList, bundleType, name)

Converts the provided Procedure FHIR object to the HealthCloud CodeSetBundle object.

param codeSetList is the list of CodeSetBundle object.
param bundleType is for defining the CodeSetBundle type.
param name is for defining the name of the CodeSetBundle.
return HealthCloud CodeSetBundle upsert fields.

(back to top)

Util

A library with needed dataweave utility functions.

Source: .src/main/resources/dwl/Util.dwl

Functions

fun clean (obj: Object)

Cleans the provided object of blank strings, null values, empty objects, and empty arrays.

param obj is an Object to clean.
return A cleaned object.

fun clean (arr: Array)

Cleans the provided array of blank strings, null values, empty objects, and empty arrays.

param arr is an Array to clean.
return A cleaned Array.

fun removeNull (arr: Array)

Removes all null items from an array.

param arr is an array.
return An array with null items removed.

fun removeNull (obj: Object)

Removes all null values from an object.

param obj is an object.
return An object with null values removed.

(back to top)