Home
API reference
FHIR® API
FHIR® resources
Specimen
read

Specimen read

get/Specimen/{id}
Page View

This resource contains information about a biological or environmental sample taken to complete testing for a patient. It also includes the substances used for gathering, maintaining, or processing the specimen. 

You can only review specimen information.

read

Review a specific Specimen resource with details about a biological or environmental sample taken for patient testing.

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Specimen/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    Specimen identifier

Response fields and example

Blood
json
1
{}
  • resourceType
    required, string

    Identifies the type of the resource

    Value: Specimen
  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • identifier
    Array of object

    Id for specimen.

    • extension
      Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

      May be used to represent additional information that is not part of the basic definition of the element. 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.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system
      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • type
    object

    The kind of material that forms the specimen.

    • coding
      Array of object

      A reference to a code defined by a terminology system.

      • system
        string

        The identification of the code system that defines the meaning of the symbol in the code.

      • code
        string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    • text
      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

  • subject
    object

    Where 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.

    Must be a resource of type Patient.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • collection
    object

    Details concerning the specimen collection.

    • bodySite
      object

      Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

      • coding
        Array of object

        A reference to a code defined by a terminology system.

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      • text
        string

        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

    • collectedDateTime
      string

      Time when specimen was collected from subject - the physiologically relevant time.