Newer Version Available

This content describes an older version of this product. View Latest

Prerequisites

Notes about lookups

To ensure uniqueness, when you create a HealthcareProviderSpecialty record with a SpecialtyId lookup field, a CareSpecialty record must exist with the CareSpecialty.SpecialtyCode field populated.

When you create a HealthcareProviderTaxonomy record, a CareTaxonomy.TaxonomyCode field must exist.

When you create a HealthcareFacilityNetworkSame record, a HealthcarePayerNetwork.Code field must exist.

You can look up to Operating Hours records if they exist, or create Operating Hours records via API.

For all other lookups, information should be provided in this format:

1"AccountId":{ 
2      "value":"101",
3      "referenceField":"HCGA__SourceSystemId__c"
4      }
In this example,
  • AccountId is the API name of the lookup field you want to populate.
  • referenceField is the field on the lookup object to establish the relationship. You can choose any reference field for these lookups as long as the values are unique.
  • value is the value of the referenceField.

When a single request includes multiple lookups to an object, use the same reference field for all those lookups.

For example, suppose you have created custom lookup fields to the Account object in HealthcareProviderSpecialty and healthcareTaxonomy. The lookup fields are called C_Account1 and C_Account2. Account1 record has its sourceSystem field set to A1, and Account2 record has the sourceSystem field set to A2. You want C_Account1 to be populated with the Account1 record and C_Account2 to be populated with Account2. The reference field to find the account record is SourceSystem. If sourceSystem is A1, you get the Account1 record, and if sourceSystem is A2 you get the Account2 record.

HealthcareFacilityNetwork has lookups to Account, Practitioner and HealthcarePractitionerFacility. You can create a HealthcareFacilityNetwork record in an input request in any of these ways:
  • Create a record with an account lookup for the facility you are creating.
  • Create a record with a practitioner lookup for the practitioner you are creating.
  • Create a record with a lookup to HealthcarePractitionerFacility for a practitioner at a given facility.

Apex is not directly supported. However, you can call this API using the HttpRequest Apex class.