Get a code value by code value identifier
/20240101/codeValues/{codeValueId}
Request
-
codeValueId(required): string
Unique code value identifier
-
authorization(required): string
Contains the credentials to authenticate a consumer to the service.
-
opc-request-id: string
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.
Response
- application/json
200 Response
-
opc-request-id: string
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.
object
-
cdfMeaning:
string
A programmatic value, primarily used by applications to search for this value.
-
cki:
string
This value is programmatically assigned for any code value created and shipped by Oracle Cerner. This value is common between all domains.
-
codeSet(required):
string
The ID of the code set this code value is part of.
-
conceptCki:
string
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.
-
definition:
string
A text field that can be used to store additional information related to the code value.
-
description:
string
A secondary way of describing the purpose of this code value row to provide more information.
-
display:
string
The text that consumers see that represents this code value.
-
id(required):
string
The ID of the code value.
-
isActive(required):
boolean
Indicates if the code value is active or not.
-
isAuthenticated(required):
boolean
Indicates if the code value has been authenticated or not.
-
sequence:
integer(int64)
Minimum Value:
0
This value is used to help define relative ordering within a group of related code values.
400 Response
-
opc-request-id: string
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.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array 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.
array
array
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.
401 Response
-
opc-request-id: string
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.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array 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.
array
array
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.
404 Response
-
opc-request-id: string
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.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array 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.
array
array
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.
429 Response
-
opc-request-id: string
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.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array 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.
array
array
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.
500 Response
-
opc-request-id: string
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.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
details:
array details
A list of details regarding any errors from the resulting service call.
-
message(required):
string
A human-readable error message.
array
-
Array of:
object ErrorDetail
Additional detail information pertaining to the error.
object
-
detail:
string
A human-readable explanation specific to this occurrence of the problem.
-
source:
object ErrorDetailSource
An object containing references to the source of the error.
object
-
headers:
array headers
A list of the request headers which caused the error.
-
parameters:
array parameters
A list of which URI query parameters caused the error.
-
pointers:
array 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.
array
array
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.