HDR FHIR API

GET CodeSystem Resource Bundle

get

/oracle-fhir-server/fhir/CodeSystem

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

A code defined in the code system
content-mode(optional): string

not-present | example | fragment | complete | supplement
context(optional): string

A use context assigned to the code system
context-quantity(optional): integer

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

A type of use context assigned to the code system
context-type-quantity(optional): string

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

A use context type and value assigned to the code system
date(optional): string(date)

The code system publication date
description(optional): string

The description of the code system
identifier(optional): string

External identifier for the code system
jurisdiction(optional): string

Intended jurisdiction for the code system
language(optional): string

A language in which a designation is provided
name(optional): string

Computationally friendly name of the code system
publisher(optional): string

Name of the publisher of the code system
status(optional): string

The current status of the code system
supplements(optional): string

Find code system supplements for the referenced code system
system(optional): string

The system for any codes defined by this code system (same as 'url')
title(optional): string

The human-friendly name of the code system
url(optional): string

The uri that identifies the code system
version(optional): string

The business version of the code system

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object CodeSystem

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

Nested Schema : CodeSystem

Type: object

Show Source

caseSensitive: boolean
concept: array concept

Minimum Number of Items: 1

Unique Items Required: true
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
content: string

Minimum Length: 1
date: string

Minimum Length: 1
description: string

Minimum Length: 1
experimental: boolean
filter: array filter

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 CodeSystem_meta
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
title: string

Minimum Length: 1
url: string

Minimum Length: 1
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "caseSensitive",
        "concept",
        "contact",
        "content",
        "date",
        "description",
        "experimental",
        "filter",
        "id",
        "identifier",
        "meta",
        "name",
        "publisher",
        "resourceType",
        "status",
        "text",
        "title",
        "url",
        "version"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "meta":{
            "$ref":"#/definitions/CodeSystem_meta"
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "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
        },
        "caseSensitive":{
            "type":"boolean"
        },
        "content":{
            "type":"string",
            "minLength":1
        },
        "filter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CodeSystem_filter"
            },
            "minItems":1
        },
        "concept":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CodeSystem_concept"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : concept

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CodeSystem_concept

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CodeSystem_filter

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

Type: object

Show Source

profile: array profile

{
    "required":[
        "profile"
    ],
    "properties":{
        "profile":{
            "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 : CodeSystem_concept

Type: object

Show Source

code: string

Minimum Length: 1
definition: string

Minimum Length: 1
designation(optional): array designation

Minimum Number of Items: 1

Unique Items Required: true
display: string

Minimum Length: 1

{
    "required":[
        "code",
        "definition",
        "display"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        },
        "definition":{
            "type":"string",
            "minLength":1
        },
        "designation":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CodeSystem_designation"
            },
            "minItems":1
        }
    }
}

Nested Schema : designation

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CodeSystem_designation

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

Nested Schema : CodeSystem_designation

Type: object

Show Source

use(optional): object ActivityDefinition_code
value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "use":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

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

Type: object

Show Source

code: string

Minimum Length: 1
description: string

Minimum Length: 1
operator(optional): array operator
value: string

Minimum Length: 1

{
    "required":[
        "code",
        "description",
        "value"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "operator":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : operator

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

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

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