Specimen - FHIR Resource (dstu2)


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
parenttrueReference Specimen from which this specimen originated
receivedTimefalsedateTime The time when specimen was received for processing
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
treatmenttrueData Type Treatment and processing step details
typefalseCodeableConcept Kind of material that forms the specimen

Specimen Structure


  
{
  "resourceType" : "Specimen",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Identifier
  "status" : "<code>", // available | unavailable | unsatisfactory | entered-in-error
  "type" : { CodeableConcept }, // Kind of material that forms the specimen
  "parent" : [{ Reference(Specimen) }], // Specimen from which this specimen originated
  "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
  "accessionIdentifier" : { Identifier }, // Identifier assigned by the lab
  "receivedTime" : "<dateTime>", // The time when specimen was received for processing
  "collection" : { // Collection details
    "collector" : { Reference(Practitioner) }, // Who collected the specimen
    "comment" : ["<string>"], // Collector comments
    // 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
  },
  "treatment" : [{ // Treatment and processing step details
    "description" : "<string>", // Textual description of procedure
    "procedure" : { CodeableConcept }, // Indicates the treatment or processing step  applied to the specimen
    "additive" : [{ Reference(Substance) }] // Material used in the processing step
  }],
  "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) }
  }]
}


 

Specimen Search Parameters

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

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