Specimen

Specimen returns information about a sample.

Query

Endpoint

GET <serveraddress>/fhir/Specimen

Parameter

Parameter	Query example	Description
id	<endpoint>/<id>	the technical id of the sample
identifier	<endpoint>?identifier=<identifier>	the external identifier of the sample
request	<endpoint>?request=<requestId>	the technical id of the order
request.identifier	<endpoint>?request.identifier=<requestIdentifier>	the external identifier of the order

Combinations of search parameters are not supported.

Searching identifiers with a specific system or the internal identifiers are not supported.

Example

{
    "resourceType": "Specimen",
    "id": "specimen-example",
    "identifier":  [
        {
            "system": "http://www.qualitype.de/samples/fhir/NamingSystem/specimen-identifier",
            "value": "sample-intern-123"
        },
        {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    ],
    "status": "available",
    "type": {
        "coding":  [
            {
                "code": "SAMPLETYPE-1",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/sampletypes",
                "display": "Sample type 1"
            }
        ]
    },
    "request":  [
        {
            "reference": "ServiceRequest/servicerequest-example",
            "identifier": {
                "system": "http://www.acme.com/fhir/NamingSystem/servicerequest-identifier",
                "value": "order-extern-123"
            }
        }
    ],
    "collection": {
        "collectedDateTime": "2023-07-01T12:00:00+00:00"
    },
    "container":  [
        {
            "specimenQuantity": {
                "value": 5,
                "code": "mL",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/units",
                "unit": "Milliliter"
            }
        }
    ]
}