HDR FHIR API

GET Bundle Resource Bundle

get

/oracle-fhir-server/fhir/Bundle

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
composition(optional): string

The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents
identifier(optional): string

Persistent identifier for the bundle
message(optional): string

The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents
timestamp(optional): string(date)

When the bundle was assembled
type(optional): string

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Bundle

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

Nested Schema : Bundle

Type: object

Show Source

entry: array entry

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
link: array link

Minimum Number of Items: 1

Unique Items Required: true
meta: object Bundle_meta
resourceType: string

Minimum Length: 1
total: number
type: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "entry",
        "id",
        "link",
        "meta",
        "resourceType",
        "total",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "meta":{
            "$ref":"#/definitions/Bundle_meta"
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "total":{
            "type":"number"
        },
        "link":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Bundle_link"
            },
            "minItems":1
        },
        "entry":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Bundle_entry"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : entry

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Bundle_entry

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

Nested Schema : link

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Bundle_link

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

Nested Schema : Bundle_meta

Type: object

Show Source

lastUpdated: string

Minimum Length: 1
tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : Bundle_entry

Type: object

Show Source

fullUrl: string

Minimum Length: 1
resource(optional): object Bundle_resource
search(optional): object Bundle_search

{
    "required":[
        "fullUrl"
    ],
    "properties":{
        "fullUrl":{
            "type":"string",
            "minLength":1
        },
        "resource":{
            "$ref":"#/definitions/Bundle_resource"
        },
        "search":{
            "$ref":"#/definitions/Bundle_search"
        }
    }
}

Nested Schema : Bundle_resource

Type: object

Show Source

id: string

Minimum Length: 1
intent: string

Minimum Length: 1
medicationReference: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text

{
    "required":[
        "id",
        "intent",
        "medicationReference",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "intent":{
            "type":"string",
            "minLength":1
        },
        "medicationReference":{
            "$ref":"#/definitions/Account_coverage"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : Bundle_search

Type: object

Show Source

mode: string

Minimum Length: 1
score: number

{
    "required":[
        "mode",
        "score"
    ],
    "properties":{
        "mode":{
            "type":"string",
            "minLength":1
        },
        "score":{
            "type":"number"
        }
    }
}

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

Type: object

Show Source

relation: string

Minimum Length: 1
url: string

Minimum Length: 1

{
    "required":[
        "relation",
        "url"
    ],
    "properties":{
        "relation":{
            "type":"string",
            "minLength":1
        },
        "url":{
            "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
        }
    }
}