HDR FHIR API

GET Group Resource Bundle

get

/oracle-fhir-server/fhir/Group

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
actual(optional): string

Descriptive or actual
characteristic(optional): string

Kind of characteristic
characteristic-value(optional): string

A composite of both characteristic and value
code(optional): string

The kind of resources contained
exclude(optional): string

Group includes or excludes
identifier(optional): string

Unique id
managing-entity(optional): string

Entity that is the custodian of the Group's definition
member(optional): string

Reference to the group member
type(optional): string

The type of resources the group contains
value(optional): string

Value held by characteristic

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Group

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

Nested Schema : Group

Type: object

Show Source

actual: boolean
characteristic: array characteristic

Minimum Number of Items: 1

Unique Items Required: true
code: object ActivityDefinition_topic
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
name: string

Minimum Length: 1
quantity: number
resourceType: string

Minimum Length: 1
text: object Account_text
type: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "actual",
        "characteristic",
        "code",
        "id",
        "identifier",
        "meta",
        "name",
        "quantity",
        "resourceType",
        "text",
        "type"
    ],
    "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
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "actual":{
            "type":"boolean"
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "quantity":{
            "type":"number"
        },
        "characteristic":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Group_characteristic"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : characteristic

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Group_characteristic

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

Type: object

Show Source

code(optional): object ActivityDefinition_topic
exclude: boolean
valueCodeableConcept(optional): object ActivityDefinition_topic

{
    "required":[
        "exclude"
    ],
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "valueCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "exclude":{
            "type":"boolean"
        }
    }
}

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