specimens

Create Specimen

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

A sample to be used for analysis.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Specimen resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statusavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subjectReferenceWhere 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.
receivedTimedateTimeTime 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 service 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.
conditionarray(CodeableConcept)A mode or state of being that describes the nature of the specimen.
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/4/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*This is a Specimen resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statusavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subjectReferenceWhere 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.
receivedTimedateTimeTime 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 service 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.
conditionarray(CodeableConcept)A mode or state of being that describes the nature of the specimen.
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/4/Specimen/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Specimen

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Specimen/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Specimen

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Specimen

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Specimen/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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*This is a Specimen resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statusavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subjectReferenceWhere 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.
receivedTimedateTimeTime 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 service 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.
conditionarray(CodeableConcept)A mode or state of being that describes the nature of the specimen.
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/4/Specimen/{resourceId}

A sample to be used for analysis.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Specimen resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statusavailable|unavailable|unsatisfactory|entered-in-errorThe availability of the specimen.
typeCodeableConceptThe kind of material that forms the specimen.
subjectReferenceWhere 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.
receivedTimedateTimeTime 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 service 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.
conditionarray(CodeableConcept)A mode or state of being that describes the nature of the specimen.
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