specimens

Create Specimen

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

A sample to be used for analysis.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringSpecimenThis is a Specimen resource
identifierarray(Identifier)Id for specimen.
accessionIdentifierIdentifierThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
statusstringavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subject*ReferenceWhere the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTimestringTime when specimen was received for processing or testing.
parentarray(Reference)Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
requestarray(Reference)Details concerning a test or procedure request that required a specimen to be collected.
collectionSpecimen_CollectionDetails concerning the specimen collection.
processingarray(Specimen_Processing)Details concerning processing and processing steps for the specimen.
containerarray(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.
notearray(Annotation)To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

Patch Specimen

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

A sample to be used for analysis.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSpecimenThis is a Specimen resource
identifierarray(Identifier)Id for specimen.
accessionIdentifierIdentifierThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
statusstringavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subject*ReferenceWhere the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTimestringTime when specimen was received for processing or testing.
parentarray(Reference)Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
requestarray(Reference)Details concerning a test or procedure request that required a specimen to be collected.
collectionSpecimen_CollectionDetails concerning the specimen collection.
processingarray(Specimen_Processing)Details concerning processing and processing steps for the specimen.
containerarray(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.
notearray(Annotation)To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

Read Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accessionstring
bodysitestring
collectedstring
collectorstring
containerstring
container-idstring
identifierstring
parentstring
patientstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Specimen

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Specimen

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

A sample to be used for analysis.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accessionstring
bodysitestring
collectedstring
collectorstring
containerstring
container-idstring
identifierstring
parentstring
patientstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSpecimenThis is a Specimen resource
identifierarray(Identifier)Id for specimen.
accessionIdentifierIdentifierThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
statusstringavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subject*ReferenceWhere the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTimestringTime when specimen was received for processing or testing.
parentarray(Reference)Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
requestarray(Reference)Details concerning a test or procedure request that required a specimen to be collected.
collectionSpecimen_CollectionDetails concerning the specimen collection.
processingarray(Specimen_Processing)Details concerning processing and processing steps for the specimen.
containerarray(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.
notearray(Annotation)To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response

Update Specimen

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

A sample to be used for analysis.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSpecimenThis is a Specimen resource
identifierarray(Identifier)Id for specimen.
accessionIdentifierIdentifierThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
statusstringavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subject*ReferenceWhere the specimen came from. This may be from the patient(s) or from the environment or a device.
receivedTimestringTime when specimen was received for processing or testing.
parentarray(Reference)Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
requestarray(Reference)Details concerning a test or procedure request that required a specimen to be collected.
collectionSpecimen_CollectionDetails concerning the specimen collection.
processingarray(Specimen_Processing)Details concerning processing and processing steps for the specimen.
containerarray(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.
notearray(Annotation)To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Response