Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page contains documentation links for Specimen-List action events which are supported in OpenSpecimen (Catissue).

 

Please find below links for documentation for each method.

 

  1. Create Specimen-List.
  2. Update Specimen-List.
  3. Get Specimen-List Details.
  4. Get Specimen-Lists for current user.
  5. Delete Specimen-List.
  6. Get Specimen-List items.
  7. Update Specimen-Lists.
  8. Share Specimen-Lists.

 

 

...

Summary

Specimen List is a tag which contains collection of specimens. Specimen list can be used for bulk ordering, categorizing specimens, user defined tagging of specimens. A specimen list can have zero or more specimens, specimens which are in pending state can't be added to specimen list, a specimen has to be collected before it can be added to a specimen list. A specimen list can be shared with users who will have read access to specimen list. Owner of a specimen list can grant/revoke access on a specific specimen list to users.

Attributes

AttributeDescription
idUnique identifier for a specimen list. It is auto-generated by OpenSpecimen.
labelIs a tag associated with label. This is unique, a user cannot have multiple specimen-lists with same label.
ownerOwner of a specimen list is defined by the user who has created it. Specimen list is only visible to owner and users with whom it is shared with and only owner has privileges to update, delete and share the specimen list with other users.
sharedWithIs a set of users who have read access to the specimen lists. A specimen list can be shared with any number of users. Owner has full access to grant/revoke access privileges for a specimen list to users.
specimensCollection of specimens that belong to the given specimen list.

 

Operations on Specimen List

Child pages (Children Display)