HDR FHIR API

GET ValueSet Resource Bundle

get

/oracle-fhir-server/fhir/ValueSet

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

This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
context(optional): string

A use context assigned to the value set
context-quantity(optional): integer

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

A type of use context assigned to the value set
context-type-quantity(optional): string

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

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

The value set publication date
description(optional): string

The description of the value set
expansion(optional): string

Identifies the value set expansion (business identifier)
identifier(optional): string

External identifier for the value set
jurisdiction(optional): string

Intended jurisdiction for the value set
name(optional): string

Computationally friendly name of the value set
publisher(optional): string

Name of the publisher of the value set
reference(optional): string

A code system included or excluded in the value set or an imported value set
status(optional): string

The current status of the value set
title(optional): string

The human-friendly name of the value set
url(optional): string

The uri that identifies the value set
version(optional): string

The business version of the value set

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ValueSet

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

Nested Schema : ValueSet

Type: object

Show Source

compose: object ValueSet_compose
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
copyright: string

Minimum Length: 1
date: string

Minimum Length: 1
description: string

Minimum Length: 1
experimental: boolean
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
jurisdiction: array jurisdiction

Minimum Number of Items: 1

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

Minimum Length: 1
publisher: string

Minimum Length: 1
purpose: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
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
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "compose",
        "contact",
        "copyright",
        "date",
        "description",
        "experimental",
        "id",
        "identifier",
        "jurisdiction",
        "meta",
        "name",
        "publisher",
        "purpose",
        "resourceType",
        "status",
        "text",
        "url",
        "useContext",
        "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
        },
        "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/ValueSet_useContext"
            },
            "minItems":1
        },
        "jurisdiction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "purpose":{
            "type":"string",
            "minLength":1
        },
        "copyright":{
            "type":"string",
            "minLength":1
        },
        "compose":{
            "$ref":"#/definitions/ValueSet_compose"
        }
    },
    "description":""
}

Nested Schema : ValueSet_compose

Type: object

Show Source

inactive: boolean
include: array include

Minimum Number of Items: 1

Unique Items Required: true
lockedDate: string

Minimum Length: 1

{
    "required":[
        "inactive",
        "include",
        "lockedDate"
    ],
    "properties":{
        "lockedDate":{
            "type":"string",
            "minLength":1
        },
        "inactive":{
            "type":"boolean"
        },
        "include":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ValueSet_compose_include"
            },
            "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 : 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 : jurisdiction

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ValueSet_useContext

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

Nested Schema : include

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ValueSet_compose_include

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

Nested Schema : ValueSet_compose_include

Type: object

Show Source

concept(optional): array concept

Minimum Number of Items: 1

Unique Items Required: true
system: string

Minimum Length: 1
version: string

Minimum Length: 1

{
    "required":[
        "system",
        "version"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "concept":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : concept

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

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

Nested Schema : Appointment_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1

{
    "required":[
        "code",
        "display"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "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 : ActivityDefinition_jurisdiction

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

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

Nested Schema : ValueSet_useContext

Type: object

Show Source

code(optional): object ActivityDefinition_code
valueQuantity(optional): object ValueSet_valueQuantity

{
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "valueQuantity":{
            "$ref":"#/definitions/ValueSet_valueQuantity"
        }
    }
}

Nested Schema : ValueSet_valueQuantity

Type: object

Show Source

code: string

Minimum Length: 1
comparator: string

Minimum Length: 1
system: string

Minimum Length: 1
unit: string

Minimum Length: 1
value: number

{
    "required":[
        "code",
        "comparator",
        "system",
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "comparator":{
            "type":"string",
            "minLength":1
        },
        "unit":{
            "type":"string",
            "minLength":1
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}