Get a code value by code value identifier

get

/20240101/codeValues/{codeValueId}

Retrieves a code value by code value identifier.

Request

Path Parameters
Header Parameters
  • Contains the credentials to authenticate a consumer to the service.
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Back to Top

Response

Supported Media Types

200 Response

Indicates that the details for a code value were successfully found.
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : CodeValue
Type: object
The full representation of a code value.
Show Source
  • A programmatic value, primarily used by applications to search for this value.
  • This value is programmatically assigned for any code value created and shipped by Oracle Cerner. This value is common between all domains.
  • The ID of the code set this code value is part of.
  • The functional Concept Identifier that is the codified means within Millennium Platform to identify key medical concepts to support information processing, clinical decision support, executable knowledge, and knowledge presentation.
  • A text field that can be used to store additional information related to the code value.
  • A secondary way of describing the purpose of this code value row to provide more information.
  • The text that consumers see that represents this code value.
  • The ID of the code value.
  • Indicates if the code value is active or not.
  • Indicates if the code value has been authenticated or not.
  • Minimum Value: 0
    This value is used to help define relative ordering within a group of related code values.

400 Response

Bad Request
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • pointers

    A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

    For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • pointers

    A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

    For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

404 Response

Not Found
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • pointers

    A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

    For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • pointers

    A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

    For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.
Body ()
Root Schema : ApiError
Type: object
Error information.
Show Source
Nested Schema : details
Type: array
A list of details regarding any errors from the resulting service call.
Show Source
Nested Schema : ErrorDetail
Type: object
Additional detail information pertaining to the error.
Show Source
Nested Schema : ErrorDetailSource
Type: object
An object containing references to the source of the error.
Show Source
  • headers
    A list of the request headers which caused the error.
  • parameters
    A list of which URI query parameters caused the error.
  • pointers

    A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

    For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Nested Schema : headers
Type: array
A list of the request headers which caused the error.
Show Source
Nested Schema : parameters
Type: array
A list of which URI query parameters caused the error.
Show Source
Nested Schema : pointers
Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source
Back to Top