HDR FHIR API

GET Specimen Resource Bundle

get

/oracle-fhir-server/fhir/Specimen

This endpoint supports the retrieval of Specimen resource list.It returns Bundle of Specimen resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
accession(optional): string

The accession number associated with the specimen
bodysite(optional): string

The code for the body site from where the specimen originated
collected(optional): string(date)

The date the specimen was collected
collector(optional): string

Who collected the specimen
container(optional): string

The kind of specimen container
container-id(optional): string

The unique identifier associated with the specimen container
identifier(optional): string

The unique identifier associated with the specimen
parent(optional): string

The parent of the specimen
patient(optional): string

The patient the specimen comes from
status(optional): string

available | unavailable | unsatisfactory | entered-in-error
subject(optional): string

The subject of the specimen
type(optional): string

The specimen type

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Specimen

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Specimen"
    }
}

Nested Schema : Specimen

Type: object

Show Source

accessionIdentifier: object Account_identifier
collection: object Specimen_collection
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
container: array container

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
note: array note

Minimum Number of Items: 1

Unique Items Required: true
receivedTime: string

Minimum Length: 1
request: array request

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_subject
text: object Account_text
type: object ActivityDefinition_valueCodeableConcept

{
    "type":"object",
    "required":[
        "accessionIdentifier",
        "collection",
        "contained",
        "container",
        "id",
        "identifier",
        "meta",
        "note",
        "receivedTime",
        "request",
        "resourceType",
        "status",
        "subject",
        "text",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Specimen_contained"
            },
            "minItems":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "accessionIdentifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "receivedTime":{
            "type":"string",
            "minLength":1
        },
        "request":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "collection":{
            "$ref":"#/definitions/Specimen_collection"
        },
        "container":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Specimen_container"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Specimen_collection

Type: object

Show Source

bodySite: object Account_type
collectedDateTime: string

Minimum Length: 1
collector: object Account_coverage
method: object Basic_code
quantity: object MedicationKnowledge_amount

{
    "required":[
        "bodySite",
        "collectedDateTime",
        "collector",
        "method",
        "quantity"
    ],
    "properties":{
        "collector":{
            "$ref":"#/definitions/Account_coverage"
        },
        "collectedDateTime":{
            "type":"string",
            "minLength":1
        },
        "quantity":{
            "$ref":"#/definitions/MedicationKnowledge_amount"
        },
        "method":{
            "$ref":"#/definitions/Basic_code"
        },
        "bodySite":{
            "$ref":"#/definitions/Account_type"
        }
    }
}

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Specimen_contained

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Specimen_contained"
    },
    "minItems":1
}

Nested Schema : container

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Specimen_container

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Specimen_container"
    },
    "minItems":1
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_identifier"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : note

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_topic"
    },
    "minItems":1
}

Nested Schema : request

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":1
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Account_type

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "coding",
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Basic_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : MedicationKnowledge_amount

Type: object

Show Source

unit: string

Minimum Length: 1
value: number

{
    "required":[
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_code"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Specimen_contained

Type: object

Show Source

code(optional): object Basic_code
id: string

Minimum Length: 1
resourceType: string

Minimum Length: 1

{
    "required":[
        "id",
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "$ref":"#/definitions/Basic_code"
        }
    }
}

Nested Schema : Specimen_container

Type: object

Show Source

additiveReference(optional): object Account_coverage
capacity(optional): object MedicationKnowledge_amount
description: string

Minimum Length: 1
identifier(optional): array identifier

Minimum Number of Items: 1

Unique Items Required: true
specimenQuantity(optional): object MedicationKnowledge_amount
type(optional): object ActivityDefinition_topic

{
    "required":[
        "description"
    ],
    "properties":{
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "capacity":{
            "$ref":"#/definitions/MedicationKnowledge_amount"
        },
        "specimenQuantity":{
            "$ref":"#/definitions/MedicationKnowledge_amount"
        },
        "additiveReference":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_who_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_who_identifier"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AuditEvent_who_identifier

Type: object

Show Source

value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}