Jump to

• Request
• Response

Get a list of specimens

get

/Specimen

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of specimens that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Specimen"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Specimen"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Specimen
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Specimen"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Specimen

Type: object

Show Source

• accessionIdentifier: accessionIdentifier
  The identifier assigned by the laboratory.
• collection: collection
  The collection details.
• condition: array condition
  The state of the specimen.
• container: array container
  The direct container of the specimen.
• id(required): string
• identifier: array identifier
  The external identifier.
• receivedTime: string (date-time)
  The time when the specimen was received for processing.
• resourceType(required): string
  Allowed Values: [ "Specimen" ]
• status: string
  The following values are supported:

  • available
  • unavailable
  • unsatisfactory
  • entered-in-error
• subject: subject
  (USCDI) The patient where the specimen came from.
• type(required): type
  (USCDI) The type of material that forms the specimen.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Specimen"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"The external identifier.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "accessionIdentifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Identifier"
                }
            ],
            "description":"The identifier assigned by the laboratory."
        },
        "status":{
            "type":"string",
            "description":"The following values are supported:\n  <ul>\n    <li><code>available</code></li>\n    <li><code>unavailable</code></li>\n    <li><code>unsatisfactory</code></li>\n    <li><code>entered-in-error</code></li>\n  </ul>\n"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The type of material that forms the specimen."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The patient where the specimen came from."
        },
        "receivedTime":{
            "type":"string",
            "format":"date-time",
            "description":"The time when the specimen was received for processing."
        },
        "collection":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SpecimenCollection"
                }
            ],
            "description":"The collection details."
        },
        "container":{
            "type":"array",
            "description":"The direct container of the specimen.",
            "items":{
                "$ref":"#/components/schemas/SpecimenContainer"
            }
        },
        "condition":{
            "type":"array",
            "description":"The state of the specimen.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : accessionIdentifier

The identifier assigned by the laboratory.

Match All

The identifier assigned by the laboratory.

Show Source

• object Identifier

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Identifier"
        }
    ],
    "description":"The identifier assigned by the laboratory."
}

Nested Schema : collection

The collection details.

Match All

The collection details.

Show Source

• object SpecimenCollection

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SpecimenCollection"
        }
    ],
    "description":"The collection details."
}

Nested Schema : condition

Type: array

The state of the specimen.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"The state of the specimen.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : container

Type: array

The direct container of the specimen.

Show Source

• Array of: object SpecimenContainer

{
    "type":"array",
    "description":"The direct container of the specimen.",
    "items":{
        "$ref":"#/components/schemas/SpecimenContainer"
    }
}

Nested Schema : identifier

Type: array

The external identifier.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"The external identifier.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : subject

(USCDI) The patient where the specimen came from.

Match All

(USCDI) The patient where the specimen came from.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The patient where the specimen came from."
}

Nested Schema : type

(USCDI) The type of material that forms the specimen.

Match All

(USCDI) The type of material that forms the specimen.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The type of material that forms the specimen."
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : SpecimenCollection

Type: object

Show Source

• collectedDateTime: string (date-time)
  The collection time.
• collectedPeriod: object collectedPeriod
  The collection time.
• collector: collector
  Who collected the specimen.

{
    "type":"object",
    "properties":{
        "collector":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"Who collected the specimen."
        },
        "collectedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The collection time."
        },
        "collectedPeriod":{
            "type":"object",
            "properties":{
                "start":{
                    "type":"string",
                    "format":"date-time"
                },
                "end":{
                    "type":"string",
                    "format":"date-time"
                }
            },
            "description":"The collection time."
        }
    }
}

Nested Schema : collectedPeriod

Type: object

The collection time.

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"The collection time."
}

Nested Schema : collector

Who collected the specimen.

Match All

Who collected the specimen.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"Who collected the specimen."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : SpecimenContainer

Type: object

Show Source

• identifier: array identifier
  The ID for the container.

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"array",
            "description":"The ID for the container.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        }
    }
}

Nested Schema : identifier

Type: array

The ID for the container.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"The ID for the container.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top