HDR FHIR API

GET OperationDefinition Resource Bundle

get

/oracle-fhir-server/fhir/OperationDefinition

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
base(optional): string

Marks this as a profile of the base
code(optional): string

Name used to invoke the operation
context(optional): string

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

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

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

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

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

The operation definition publication date
description(optional): string

The description of the operation definition
input-profile(optional): string

Validation information for in parameters
instance(optional): string

Invoke on an instance?
jurisdiction(optional): string

Intended jurisdiction for the operation definition
kind(optional): string

operation | query
name(optional): string

Computationally friendly name of the operation definition
output-profile(optional): string

Validation information for out parameters
publisher(optional): string

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

The current status of the operation definition
system(optional): string

Invoke at the system level?
title(optional): string

The human-friendly name of the operation definition
type(optional): string

Invoke at the type level?
url(optional): string

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

The business version of the operation definition

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object OperationDefinition

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

Nested Schema : OperationDefinition

Type: object

Show Source

base: string

Minimum Length: 1
code: string

Minimum Length: 1
comment: string

Minimum Length: 1
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
date: string

Minimum Length: 1
description: string

Minimum Length: 1
id: string

Minimum Length: 1
instance: boolean
jurisdiction: array jurisdiction

Minimum Number of Items: 1

Unique Items Required: true
kind: string

Minimum Length: 1
name: string

Minimum Length: 1
overload: array overload

Minimum Number of Items: 1

Unique Items Required: true
parameter: array parameter

Minimum Number of Items: 1

Unique Items Required: true
publisher: string

Minimum Length: 1
resource: array resource
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
system: boolean
text: object Account_text
type: boolean
url: string

Minimum Length: 1
useContext: array useContext

Minimum Number of Items: 1

Unique Items Required: true
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "base",
        "code",
        "comment",
        "contact",
        "date",
        "description",
        "id",
        "instance",
        "jurisdiction",
        "kind",
        "name",
        "overload",
        "parameter",
        "publisher",
        "resource",
        "resourceType",
        "status",
        "system",
        "text",
        "type",
        "url",
        "useContext",
        "version"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "kind":{
            "type":"string",
            "minLength":1
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CapabilityStatement_contact"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "useContext":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/OperationDefinition_useContext"
            },
            "minItems":1
        },
        "jurisdiction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "comment":{
            "type":"string",
            "minLength":1
        },
        "base":{
            "type":"string",
            "minLength":1
        },
        "resource":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "system":{
            "type":"boolean"
        },
        "type":{
            "type":"boolean"
        },
        "instance":{
            "type":"boolean"
        },
        "parameter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/OperationDefinition_parameter"
            },
            "minItems":1
        },
        "overload":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/OperationDefinition_overload"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : contact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_contact

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

Nested Schema : jurisdiction

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

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

Nested Schema : overload

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object OperationDefinition_overload

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

Nested Schema : parameter

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object OperationDefinition_parameter

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

Nested Schema : resource

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object OperationDefinition_useContext

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

Nested Schema : CapabilityStatement_contact

Type: object

Show Source

name: string

Minimum Length: 1
telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        }
    }
}

Nested Schema : telecom

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_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 : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : coding

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

Nested Schema : OperationDefinition_overload

Type: object

Show Source

comment: string

Minimum Length: 1
parameterName(optional): array parameterName

{
    "required":[
        "comment"
    ],
    "properties":{
        "parameterName":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "comment":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : parameterName

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : OperationDefinition_parameter

Type: object

Show Source

documentation: string

Minimum Length: 1
max: string

Minimum Length: 1
min: number
name: string

Minimum Length: 1
type: string

Minimum Length: 1
use: string

Minimum Length: 1

{
    "required":[
        "documentation",
        "max",
        "min",
        "name",
        "type",
        "use"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "use":{
            "type":"string",
            "minLength":1
        },
        "min":{
            "type":"number"
        },
        "max":{
            "type":"string",
            "minLength":1
        },
        "documentation":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : OperationDefinition_useContext

Type: object

Show Source

code(optional): object Account_type_coding
valueCodeableConcept(optional): object ActivityDefinition_valueCodeableConcept

{
    "properties":{
        "code":{
            "$ref":"#/definitions/Account_type_coding"
        },
        "valueCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : coding

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
}