HDR FHIR API

GET ResearchStudy Resource Bundle

get

/oracle-fhir-server/fhir/ResearchStudy

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
category(optional): string

Classifications for the study
date(optional): string(date)

When the study began and ended
focus(optional): string

Drugs, devices, etc. under study
identifier(optional): string

Business Identifier for study
keyword(optional): string

Used to search for the study
location(optional): string

Geographic region(s) for study
partof(optional): string

Part of larger study
principalinvestigator(optional): string

Researcher who oversees multiple aspects of the study
protocol(optional): string

Steps followed in executing study
site(optional): string

Facility where study activities are conducted
sponsor(optional): string

Organization that initiates and is legally responsible for the study
status(optional): string

active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
title(optional): string

Name for this study

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ResearchStudy

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

Nested Schema : ResearchStudy

Type: object

Show Source

id: string

Minimum Length: 1
meta: object Account_meta
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "id",
        "meta",
        "resourceType",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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 : 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 : 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 : 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
        }
    }
}