HDR FHIR API

GET List Resource Bundle

get

/oracle-fhir-server/fhir/List

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
code(optional): string

What the purpose of this list is
date(optional): string(date)

When the list was prepared
empty-reason(optional): string

Why list is empty
encounter(optional): string

Context in which list created
identifier(optional): string

Business identifier
item(optional): string

Actual entry
notes(optional): string

The annotation - text content (as markdown)
patient(optional): string

If all resources have the same subject
source(optional): string

Who and/or what defined the list contents (aka Author)
status(optional): string

current | retired | entered-in-error
subject(optional): string

If all resources have the same subject
title(optional): string

Descriptive name for the list

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object List

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

Nested Schema : List

Type: object

Show Source

date: string

Minimum Length: 1
encounter: object Account_coverage
entry: array entry

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
mode: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
source: object Account_coverage
status: string

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

{
    "type":"object",
    "required":[
        "date",
        "encounter",
        "entry",
        "id",
        "identifier",
        "meta",
        "mode",
        "resourceType",
        "source",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "mode":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "source":{
            "$ref":"#/definitions/Account_coverage"
        },
        "entry":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/List_entry"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : entry

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object List_entry

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/List_entry"
    },
    "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 : 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 : List_entry

Type: object

Show Source

deleted: boolean
flag(optional): object ActivityDefinition_topic
item(optional): object Account_coverage

{
    "required":[
        "deleted"
    ],
    "properties":{
        "flag":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "deleted":{
            "type":"boolean"
        },
        "item":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

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