Create a new provider profile import

To import a profile from an external source, you must first create an import request. When the request is initiated, the provider profile record will be created with a “Pending” status. When complete, the status will change to “Completed”.

If the request is successful, the provider profile will have a “Profile" value. If an error occurs, the profile will have a "FailureCode" and "FailureDescription" value.

Request
Request Body schema: application/json
providerId
required
string <uuid>

The provider unique identifier associated with this profile import.

source
required
string

Source of the import.

Enum: "Npi" "CaqhPo" "AmericanMedicalAssociationPhysician" "AmericanMedicalAssociationPhysicianAssistant"
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

post/providers/profiles/import
Request samples
application/json
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "source": "Npi"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "source": "Npi",
  • "started": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "trigger": "Manual",
  • "failureCode": "DatabaseError",
  • "failureReason": {
    },
  • "profile": {
    },
  • "parameters": [
    ]
}