Specimen
Semantical type
The “type” field of the resource is used to determine the semantical type of the resource. It is mandantory. Look at the List of registered codes for a complete list of codes registered in MIDATA. Include the required codes into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single Specimen by id.
Request:
[GET] /fhir/Specimen/<id>
Read specific version
Read a specific version of a single Specimen by id.
Request:
[GET] /fhir/Specimen/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Specimen/<id>/_history
Search
Search for resources of type Specimen
Request:
[GET] /fhir/Specimen?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| accession | token | The accession number associated with the specimen |
| bodysite | token | The code for the body site from where the specimen originated |
| collected | date | The date the specimen was collected |
| collector | reference | Who collected the specimen |
| container | token | The kind of specimen container |
| container-id | token | The unique identifier associated with the specimen container |
| identifier | token | The unique identifier associated with the specimen |
| parent | reference | The parent of the specimen |
| patient | reference | The patient the specimen comes from |
| status | token | available - unavailable - unsatisfactory - entered-in-error |
| subject | reference | The subject of the specimen |
| type | token | The specimen type |
Create
Create a new resource of type Specimen.
Request:
[POST] /fhir/Specimen
Update
Updates a resource of type Specimen.
Request:
[PUT] /fhir/Specimen/<id>