HDR FHIR API

GET ResearchDefinition Resource Bundle

get

/oracle-fhir-server/fhir/ResearchDefinition

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
composed-of(optional): string

What resource is being referenced
context(optional): string

A use context assigned to the research definition
context-quantity(optional): integer

A quantity- or range-valued use context assigned to the research definition
context-type(optional): string

A type of use context assigned to the research definition
context-type-quantity(optional): string

A use context type and quantity- or range-based value assigned to the research definition
context-type-value(optional): string

A use context type and value assigned to the research definition
date(optional): string(date)

The research definition publication date
depends-on(optional): string

What resource is being referenced
derived-from(optional): string

What resource is being referenced
description(optional): string

The description of the research definition
effective(optional): string(date)

The time during which the research definition is intended to be in use
identifier(optional): string

External identifier for the research definition
jurisdiction(optional): string

Intended jurisdiction for the research definition
name(optional): string

Computationally friendly name of the research definition
predecessor(optional): string

What resource is being referenced
publisher(optional): string

Name of the publisher of the research definition
status(optional): string

The current status of the research definition
successor(optional): string

What resource is being referenced
title(optional): string

The human-friendly name of the research definition
topic(optional): string

Topics associated with the ResearchDefinition
url(optional): string

The uri that identifies the research definition
version(optional): string

The business version of the research definition

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ResearchDefinition

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

Nested Schema : ResearchDefinition

Type: object

Show Source

id: string

Minimum Length: 1
meta: object Account_meta
population: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "id",
        "meta",
        "population",
        "resourceType",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "population":{
            "$ref":"#/definitions/Account_coverage"
        },
        "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_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "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 : 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
        }
    }
}