Skip to main content

Admin API

The Admin API allows you to programmatically modify your projects via a REST API. You must supply your Plasma API Key, which can be found by logging into your account and viewing the settings.

Projects​

Create Project​

  • Method: POST
  • Endpoint: /api/plasma/projects/project?plasmaApiKey={plasmaApiKey}
  • Body:
{
    description: string;
    projectType: "Backend" | "Patient" | "Clinician";
    returnToUrl: string;
}

Read Project​

  • Method: GET
  • Endpoint: /api/plasma/projects/project?plasmaApiKey={plasmaApiKey}&projectId={projectId}

Update Project​

  • Method: PUT
  • Endpoint: /api/plasma/projects/project?plasmaApiKey={plasmaApiKey}&projectId={projectId}
  • Body:
{
    description: string;
    projectType: "Backend" | "Patient" | "Clinician";
    returnToUrl: string;
}

Delete Project​

  • Method: DELETE
  • Endpoint: /api/plasma/projects/project?plasmaApiKey={plasmaApiKey}&projectId={projectId}

Platforms​

Create Platform​

  • Method: POST
  • Endpoint: /api/plasma/projects/platform?plasmaApiKey={plasmaApiKey}&projectId={projectId}
  • Body:
{
    name: string;
    platformType: "SmartHealthIT" | "Epic" | "Cerner" | "Athena" | "NextGen" | "Allscripts" | "Other";
    clientId: string;
    privateKey: string;
    clientSecret: string;
    scope: string;
    siteId: string;
}

Read Platform​

  • Method: GET
  • Endpoint: /api/plasma/projects/platform?plasmaApiKey={plasmaApiKey}&projectId={projectId}&platformId={platformId}

Update Platform​

  • Method: PUT
  • Endpoint: /api/plasma/projects/platform?plasmaApiKey={plasmaApiKey}&projectId={projectId}&platformId={platformId}
  • Body:
{
    name: string;
    platformType: "SmartHealthIT" | "Epic" | "Cerner" | "Athena" | "NextGen" | "Allscripts" | "Other";
    clientId: string;
    privateKey: string;
    clientSecret: string;
    scope: string;
    siteId: string;
}

Delete Platform​

  • Method: DELETE
  • Endpoint: /api/plasma/projects/platform?plasmaApiKey={plasmaApiKey}&projectId={projectId}&platformId={platformId}

Environments​

Create Environment​

  • Method: POST
  • Endpoint: /api/plasma/projects/environment?plasmaApiKey={plasmaApiKey}&projectId={projectId}
  • Body:
{
    platformId: string;
    name: string;
    fhirUrl: string;
    authUrl: string;
    tokenUrl: string;
}

Read Environment​

  • Method: GET
  • Endpoint: /api/plasma/projects/environment?plasmaApiKey={plasmaApiKey}&projectId={projectId}&environmentId={environmentId}

Update Environment​

  • Method: PUT
  • Endpoint: /api/plasma/projects/environment?plasmaApiKey={plasmaApiKey}&projectId={projectId}&environmentId={environmentId}
  • Body:
{
    platformId: string;
    name: string;
    fhirUrl: string;
    authUrl: string;
    tokenUrl: string;
}

Delete Environment​

  • Method: DELETE
  • Endpoint: /api/plasma/projects/environment?plasmaApiKey={plasmaApiKey}&projectId={projectId}&environmentId={environmentId}