API Reference
Status

Update Project

patch
https://management.sandbox.particlehealth.com/v1/

Updates mutable fields such as display_name, npi, address, and lifecycle state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The resource name of the Project. Should match the pattern projects/{project_id}.

Body Params

A Project entity which is able to make requests against Production networks.

string

A user defined name for the Project.

string
enum

State represents represents if a Project or Connection is Active or Inactive on the data exchange networks.

  • STATE_ACTIVE: Represents a Project/Connection that is registered on the data exchange networks.
  • STATE_INACTIVE: Represents a Project that is either not registered, or not active on the data exchange networks.
  • STATE_ACTIVE_PENDING: Represents a Project that is pending registration on the data exchange networks.
Allowed:
string

National Provider Index for the Project.

address
object

Address for the Project.

string
enum

CommonwellType is a network required ENUM and should be chosen as the value that closest resembles the treatment relation this entity has with its patients.

Allowed:
boolean

True if the Project is an OBO entity on at least one of the networks.

string
Responses

Updated 11 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago