Skip to content

add.md

Latest commit

 

History

History
85 lines (60 loc) · 2.1 KB

add.md

File metadata and controls

85 lines (60 loc) · 2.1 KB
Raw

Add

Add a member to the roster.

POST {baseUrl}/v1/rosters/{customerKey}/members

URI Parameters

Name In Required Type Description
baseUrl path Yes string The API URL.
customerKey path Yes string The customer key or me.

Request Body

Name Type Required Description
fid string (format: FID) Yes FID of the physician.
ignoreExisting boolean No Ignore any existing member with the same FID.

Note: Any fields marked as deprecated will be removed in a future version of the API. New code should not rely on these fields. Existing code should be updated to use alternative fields.

Responses

Name Type Description
200 OK Member Success
400 Bad Request ProblemDetails FID is invalid or the request has bad data.
409 Conflict Member already exists and ignoreExisting is not set.

Remarks

The request contains the FID of the physician to add. If the physician is already a member of the roster then a 409 is returned unless ignoreExisting is set to true.

After a member is added to the roster then a report is generated for the new member. It is not necessary to generate the report using the API.

Security

Scopes

  • pdc.member_write

Examples

Add a Member

Sample Request

POST /v1/rosters/me/members

Request body

{
  "fid": "999999915",
  "ignoreExisting": true
}

Sample Response

Status code: 200

The response indicates a report is being generated.

{
    "fid": "999999915",
    "fullName": "Philip James Testermancho",
    "birthDate": null,
    "boardActionStatus": "Unknown",
    "currentReport": {
        "reportId": 0,
        "reportDateUtc": "0001-01-01T06:00:00Z",
        "reportGeneratedBy": "",
        "reportStatus": "Pending",
        "isComplete": false,
        "boardActionStatus": "Unknown"
    }
}