Get a nomenclature by nomenclature ID
/20240101/nomenclatures/{nomenclatureId}
Request
-
nomenclatureId(required): string
The identifier of a nomenclature.
-
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
object
-
code:
string
The unique identifier from the content source.
-
conceptCki:
string
The CKI of the concept.
-
displayName(required):
string
The display or description from the content source.
-
effectivePeriod(required):
object DateTimePeriod
A representation of a date and time range.
-
id(required):
string
The ID of the nomenclature in the context of the authority.
-
isActive(required):
boolean
Indiciates if this nomenclature is active.
-
isClientPreferred(required):
boolean
Indiciates if this nomenclature is client preferred.
-
isVendorPreferred(required):
boolean
Indiciates if this nomenclature is vendor preferred.
-
terminology(required):
string
The terminology identifier that this nomenclature belongs to.
object
-
end:
string
The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339. No time zone information is associated with this date and time.
-
start:
string
The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339. No time zone information is associated with this date and time.
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.
403 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.
412 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.