specimens

Create Specimen

post

/organizations/{organizationId}/fhir/4/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*			This is a Specimen resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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 patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
receivedTime	dateTime		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 service 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.
condition	array(CodeableConcept)		A mode or state of being that describes the nature of the specimen.
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/4/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*			This is a Specimen resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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 patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
receivedTime	dateTime		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 service 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.
condition	array(CodeableConcept)		A mode or state of being that describes the nature of the specimen.
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/4/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/4/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/4/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/4/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/4/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/4/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/4/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*			This is a Specimen resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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 patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
receivedTime	dateTime		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 service 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.
condition	array(CodeableConcept)		A mode or state of being that describes the nature of the specimen.
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/4/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*			This is a Specimen resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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 patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
receivedTime	dateTime		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 service 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.
condition	array(CodeableConcept)		A mode or state of being that describes the nature of the specimen.
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