HDR FHIR API

GET CompartmentDefinition Resource Bundle

get

/oracle-fhir-server/fhir/CompartmentDefinition

This endpoint supports the retrieval of CompartmentDefinition resource list.It returns Bundle of CompartmentDefinition 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

Patient | Encounter | RelatedPerson | Practitioner | Device
context(optional): string

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

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

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

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

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

The compartment definition publication date
description(optional): string

The description of the compartment definition
name(optional): string

Computationally friendly name of the compartment definition
publisher(optional): string

Name of the publisher of the compartment definition
resource(optional): string

Name of resource type
status(optional): string

The current status of the compartment definition
url(optional): string

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

The business version of the compartment definition

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object CompartmentDefinition

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

Nested Schema : CompartmentDefinition

Type: object

Show Source

code: 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
experimental: boolean
id: string

Minimum Length: 1
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
purpose: string

Minimum Length: 1
resource: array resource

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
search: boolean
status: string

Minimum Length: 1
text: object Account_text
url: string

Minimum Length: 1
useContext: array useContext

Minimum Number of Items: 1

Unique Items Required: true

{
    "type":"object",
    "required":[
        "code",
        "contact",
        "date",
        "description",
        "experimental",
        "id",
        "name",
        "publisher",
        "purpose",
        "resource",
        "resourceType",
        "search",
        "status",
        "text",
        "url",
        "useContext"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "experimental":{
            "type":"boolean"
        },
        "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/CapabilityStatement_useContext"
            },
            "minItems":1
        },
        "purpose":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "search":{
            "type":"boolean"
        },
        "resource":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CompartmentDefinition_resource"
            },
            "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 : resource

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CompartmentDefinition_resource

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_useContext

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

Type: object

Show Source

code: string

Minimum Length: 1
documentation: string

Minimum Length: 1
param(optional): array param

{
    "required":[
        "code",
        "documentation"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "param":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "documentation":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : param

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

Type: object

Show Source

code(optional): object ActivityDefinition_code
valueCodeableConcept(optional): object Basic_code

{
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "valueCodeableConcept":{
            "$ref":"#/definitions/Basic_code"
        }
    }
}

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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

Nested Schema : Basic_code

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/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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