v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Lab Facility Identifiers

Update Lab Facility Identifier

Retrieve a single lab vendor integration

put/api/2.0/lab_facility_identifiers/{id}/

Path parameters

idinteger required

Request body

activeboolean required

Whether the facility identifier should be used. Should be true in most cases.

compendiuminteger nullable

The id of the compendium that will be used when the user selects this facility identifier.

created_datestring date-time nullable
deleted_datestring date-time nullable
descriptionstring nullable

The text that will displayed to users in the lab order dialog.

idinteger
lab_connectioninteger nullable
lab_facilitystring required

The id that represents the lab.

practiceinteger required
practice_facilitystring required

The id that represents the practice; often an account number provided by the lab vendor.

practice_secondary_idstring nullable
user_facingboolean

Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.

Response

activeboolean required

Whether the facility identifier should be used. Should be true in most cases.

compendiuminteger nullable

The id of the compendium that will be used when the user selects this facility identifier.

created_datestring date-time nullable
deleted_datestring date-time nullable
descriptionstring nullable

The text that will displayed to users in the lab order dialog.

idinteger
lab_connectioninteger nullable
lab_facilitystring required

The id that represents the lab.

practiceinteger required
practice_facilitystring required

The id that represents the practice; often an account number provided by the lab vendor.

practice_secondary_idstring nullable
user_facingboolean

Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.