specimens

Create Specimen

post

/organizations/{organizationId}/fhir/3/Specimen

A sample to be used for analysis.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Specimen	This is a Specimen resource
identifier	array(Identifier)		Id for specimen.
accessionIdentifier	Identifier		The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
status	string	available\|unavailable\|unsatisfactory\|entered-in-error	The availability of the specimen.
type	CodeableConcept		The kind of material that forms the specimen.
subject*	Reference		Where the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTime	string		Time when specimen was received for processing or testing.
parent	array(Reference)		Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
request	array(Reference)		Details concerning a test or procedure request that required a specimen to be collected.
collection	Specimen_Collection		Details concerning the specimen collection.
processing	array(Specimen_Processing)		Details concerning processing and processing steps for the specimen.
container	array(Specimen_Container)		The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
note	array(Annotation)		To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

201 400 401 404

Patch Specimen

patch

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}

A sample to be used for analysis.

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Specimen	This is a Specimen resource
identifier	array(Identifier)		Id for specimen.
accessionIdentifier	Identifier		The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
status	string	available\|unavailable\|unsatisfactory\|entered-in-error	The availability of the specimen.
type	CodeableConcept		The kind of material that forms the specimen.
subject*	Reference		Where the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTime	string		Time when specimen was received for processing or testing.
parent	array(Reference)		Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
request	array(Reference)		Details concerning a test or procedure request that required a specimen to be collected.
collection	Specimen_Collection		Details concerning the specimen collection.
processing	array(Specimen_Processing)		Details concerning processing and processing steps for the specimen.
container	array(Specimen_Container)		The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
note	array(Annotation)		To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

200 201 400 401 404 409

Read Specimen

get

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Specimen

get

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Specimen

get

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Specimen

delete

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Specimen

get

/organizations/{organizationId}/fhir/3/Specimen

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
accession	string
bodysite	string
collected	string
collector	string
container	string
container-id	string
identifier	string
parent	string
patient	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Specimen

get

/organizations/{organizationId}/fhir/3/Specimen/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Specimen

post

/organizations/{organizationId}/fhir/3/Specimen/_search

A sample to be used for analysis.

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
accession	string
bodysite	string
collected	string
collector	string
container	string
container-id	string
identifier	string
parent	string
patient	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Specimen	This is a Specimen resource
identifier	array(Identifier)		Id for specimen.
accessionIdentifier	Identifier		The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
status	string	available\|unavailable\|unsatisfactory\|entered-in-error	The availability of the specimen.
type	CodeableConcept		The kind of material that forms the specimen.
subject*	Reference		Where the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTime	string		Time when specimen was received for processing or testing.
parent	array(Reference)		Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
request	array(Reference)		Details concerning a test or procedure request that required a specimen to be collected.
collection	Specimen_Collection		Details concerning the specimen collection.
processing	array(Specimen_Processing)		Details concerning processing and processing steps for the specimen.
container	array(Specimen_Container)		The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
note	array(Annotation)		To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

200 401 404

Update Specimen

put

/organizations/{organizationId}/fhir/3/Specimen/{resourceId}

A sample to be used for analysis.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Specimen	This is a Specimen resource
identifier	array(Identifier)		Id for specimen.
accessionIdentifier	Identifier		The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
status	string	available\|unavailable\|unsatisfactory\|entered-in-error	The availability of the specimen.
type	CodeableConcept		The kind of material that forms the specimen.
subject*	Reference		Where the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTime	string		Time when specimen was received for processing or testing.
parent	array(Reference)		Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
request	array(Reference)		Details concerning a test or procedure request that required a specimen to be collected.
collection	Specimen_Collection		Details concerning the specimen collection.
processing	array(Specimen_Processing)		Details concerning processing and processing steps for the specimen.
container	array(Specimen_Container)		The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
note	array(Annotation)		To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

200 201 400 401 404 409