Specimen - FHIR Resource (stu3)


This Specimen Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
accessionIdentifierfalseIdentifier Identifier assigned by the lab
collectionfalseData Type Collection details
containertrueData Type Direct container of specimen (tube/slide, etc.)
identifiertrueIdentifier External Identifier
notetrueAnnotation Comments
parenttrueReference Specimen from which this specimen originated
processingtrueData Type Processing and processing step details
receivedTimefalsedateTime The time when specimen was received for processing
requesttrueReference Why the specimen was collected
statusfalsecode available | unavailable | unsatisfactory | entered-in-error
subjectfalseReference Where the specimen came from. This may be from the patient(s) or from the environment or a device
typefalseCodeableConcept Kind of material that forms the specimen

Specimen Example

{
  "status": "available",
  "container": [
    {
      "capacity": {
        "unit": "mL",
        "value": 10
      },
      "description": "Green Gel tube",
      "additiveReference": {
        "reference": "#hep"
      },
      "specimenQuantity": {
        "unit": "mL",
        "value": 6
      },
      "identifier": [
        {
          "value": "48736-15394-75465"
        }
      ],
      "type": {
        "text": "Vacutainer"
      }
    }
  ],
  "accessionIdentifier": {
    "system": "http://lab.acme.org/specimens/2011",
    "value": "X352356"
  },
  "resourceType": "Specimen",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 101</p><p><b>contained</b>: </p><p><b>identifier</b>: 23234352356</p><p><b>accessionIdentifier</b>: X352356</p><p><b>status</b>: available</p><p><b>type</b>: Venous blood specimen <span>(Details : {SNOMED CT code '122555007' = 'Venous blood specimen', given as 'Venous blood specimen'})</span></p><p><b>subject</b>: <a>Peter Patient</a></p><p><b>receivedTime</b>: 04/03/2011 7:03:00 AM</p><p><b>request</b>: <a>ProcedureRequest/example</a></p><h3>Collections</h3><table><tr><td>-</td><td><b>Collector</b></td><td><b>Collected[x]</b></td><td><b>Quantity</b></td><td><b>Method</b></td><td><b>BodySite</b></td></tr><tr><td>*</td><td><a>Practitioner/example</a></td><td>30/05/2011 6:15:00 AM</td><td>6 mL</td><td>Line, Venous <span>(Details : {http://hl7.org/fhir/v2/0488 code 'LNV' = 'Line, Venous)</span></td><td>Right median cubital vein <span>(Details : {SNOMED CT code '49852007' = 'Median cubital vein', given as 'Structure of median cubital vein (body structure)'})</span></td></tr></table><h3>Containers</h3><table><tr><td>-</td><td><b>Identifier</b></td><td><b>Description</b></td><td><b>Type</b></td><td><b>Capacity</b></td><td><b>SpecimenQuantity</b></td><td><b>Additive[x]</b></td></tr><tr><td>*</td><td>48736-15394-75465</td><td>Green Gel tube</td><td>Vacutainer <span>(Details )</span></td><td>10 mL</td><td>6 mL</td><td>id: hep; Lithium/Li Heparin <span>(Details : {http://hl7.org/fhir/v3/EntityCode code 'HEPL' = 'Lithium/Li Heparin)</span></td></tr></table><p><b>note</b>: Specimen is grossly lipemic</p></div>"
  },
  "receivedTime": "2011-03-04T07:03:00Z",
  "request": [
    {
      "reference": "ProcedureRequest/example"
    }
  ],
  "collection": {
    "bodySite": {
      "text": "Right median cubital vein",
      "coding": [
        {
          "code": "49852007",
          "system": "http://snomed.info/sct",
          "display": "Structure of median cubital vein (body structure)"
        }
      ]
    },
    "collectedDateTime": "2011-05-30T06:15:00Z",
    "collector": {
      "reference": "Practitioner/example"
    },
    "method": {
      "coding": [
        {
          "code": "LNV",
          "system": "http://hl7.org/fhir/v2/0488"
        }
      ]
    },
    "quantity": {
      "unit": "mL",
      "value": 6
    }
  },
  "note": [
    {
      "text": "Specimen is grossly lipemic"
    }
  ],
  "contained": [
    {
      "resourceType": "Substance",
      "code": {
        "coding": [
          {
            "code": "HEPL",
            "system": "http://hl7.org/fhir/v3/EntityCode"
          }
        ]
      },
      "id": "hep"
    }
  ],
  "identifier": [
    {
      "system": "http://ehr.acme.org/identifiers/collections",
      "value": "23234352356"
    }
  ],
  "type": {
    "coding": [
      {
        "code": "122555007",
        "system": "http://snomed.info/sct",
        "display": "Venous blood specimen"
      }
    ]
  },
  "id": "101",
  "subject": {
    "display": "Peter Patient",
    "reference": "Patient/example"
  }
}

Specimen Structure


  
{
  "resourceType" : "Specimen",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Identifier
  "accessionIdentifier" : { Identifier }, // Identifier assigned by the lab
  "status" : "<code>", // available | unavailable | unsatisfactory | entered-in-error
  "type" : { CodeableConcept }, // Kind of material that forms the specimen
  "subject" : { Reference(Patient|Group|Device|Substance) }, // R!  Where the specimen came from. This may be from the patient(s) or from the environment or a device
  "receivedTime" : "<dateTime>", // The time when specimen was received for processing
  "parent" : [{ Reference(Specimen) }], // Specimen from which this specimen originated
  "request" : [{ Reference(ProcedureRequest) }], // Why the specimen was collected
  "collection" : { // Collection details
    "collector" : { Reference(Practitioner) }, // Who collected the specimen
    // collected[x]: Collection time. One of these 2:
    "collectedDateTime" : "<dateTime>",
    "collectedPeriod" : { Period },
    "quantity" : { Quantity(SimpleQuantity) }, // The quantity of specimen collected
    "method" : { CodeableConcept }, // Technique used to perform collection
    "bodySite" : { CodeableConcept } // Anatomical collection site
  },
  "processing" : [{ // Processing and processing step details
    "description" : "<string>", // Textual description of procedure
    "procedure" : { CodeableConcept }, // Indicates the treatment step  applied to the specimen
    "additive" : [{ Reference(Substance) }], // Material used in the processing step
    // time[x]: Date and time of specimen processing. One of these 2:
    "timeDateTime" : "<dateTime>"
    "timePeriod" : { Period }
  }],
  "container" : [{ // Direct container of specimen (tube/slide, etc.)
    "identifier" : [{ Identifier }], // Id for the container
    "description" : "<string>", // Textual description of the container
    "type" : { CodeableConcept }, // Kind of container directly associated with specimen
    "capacity" : { Quantity(SimpleQuantity) }, // Container volume or size
    "specimenQuantity" : { Quantity(SimpleQuantity) }, // Quantity of specimen within container
    // additive[x]: Additive associated with container. One of these 2:
    "additiveCodeableConcept" : { CodeableConcept }
    "additiveReference" : { Reference(Substance) }
  }],
  "note" : [{ Annotation }] // Comments
}


 

Specimen Search Parameters

The following search parameters can be used to query Specimen resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Specimen?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
accessiontextaccessionIdentifier
bodysitetextcollection.bodySite
collecteddatecollection.collected
collectorreferencecollection.collector
containertextcontainer.type
container-idtextcontainer.identifier
identifiertextidentifier
parentreferenceparent
patientreferencesubject
statustextstatus
subjectreferencesubject
typetexttype