Get Resources Output

The response body containing the results of the resource search.

JSON Example

{
  "matchingProviders": [
    {
      "acceptedInsurancePlans": [
        "Any Plan"
      ],
      "acceptingNewPatients": true,
      "additionalDetails": {},
      "certifications": [],
      "educationLevel": "high",
      "facilityAddress": {
        "addressText": "address",
        "city": "<city acronym>",
        "state": "<state acronym>",
        "postalCode": "123456",
        "country": "<country acronym>",
        "latitude": 22.2222,
        "longitude": -33.3333
      },
      "facilityName": "Any Hospital",
      "facilityPhone": "111-111-1111",
      "gender": "male",
      "languagesSpoken": [],
      "licenseCountries": [],
      "licenseRegions": [],
      "licenseStates": [],
      "licenseStatuses": [],
      "licenses": [],
      "nationalProviderIdentifier": "0123456789",
      "photoUrl": "/services/images/photo/001SB00000sb6aid",
      "providerId": "<provider_Id>",
      "providerName": "Dr. John Dae",
      "providerType": "Medical Doctor",
      "sourceSystem": "cerner",
      "specialties": [],
      "subSpecialties": []
    }
  ]
}

Properties

Property Name Type Description Required
providerSearchResults Provider Search Result A list of healthcare providers or practitioners who match the search criteria. Required
assetSearchResults Asset Search Result A list of available assets or resources (e.g., medical equipment, examination rooms) that match the search criteria. Required
errors Array of Objects An array of errors that were found, if any. Optional