Jump to

• Request
• Response

Get nomenclatures for a supplied terminology group

get

/20240101/nomenclatures

Retrieves nomenclatures for the supplied terminology group.

Request

Query Parameters

• groupId(required): string
  The terminology group identifier.
• groupType(required): string
  The terminology group type.

  Allowed Values: [ "problem", "procedure", "drg" ]
• limit: integer
  Minimum Value: 1000

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List request.

  Default Value: 1000
• search(required): string
  The search string.

Header Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : NomenclatureCollection

Type: object

Represents a collection of nomenclatures.

Show Source

• items(required): array items
  The collection of nomenclatures.

{
    "description":"Represents a collection of nomenclatures.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"The collection of nomenclatures.",
            "items":{
                "$ref":"#/definitions/NomenclatureSummary"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

The collection of nomenclatures.

Show Source

• Array of: object NomenclatureSummary
  The details of a returned nomenclature entry.

{
    "description":"The collection of nomenclatures.",
    "items":{
        "$ref":"#/definitions/NomenclatureSummary"
    },
    "type":"array"
}

Nested Schema : NomenclatureSummary

Type: object

The details of a returned nomenclature entry.

Show Source

• code: string
  The unique code given to the term by the terminology.
• crossMappedNomenclatures: array crossMappedNomenclatures
  Nomenclatures from other medical terminologies that are cross-mapped to this nomenclature. A cross-mapped nomenclature is an equivalent term from a more or less specific medical terminology. This field may be empty. Values are only returned when the groupType is Problem.
• displayName(required): string
  The display or description from the content source.
• id(required): string
  The ID of the nomenclature in the context of the authority.
• isFavorite: boolean
  Indicator specifying that the nomenclature is a favorite nomenclature. Values are only returned when the groupType is Problem.
• specificity: string
  Allowed Values: [ "POST_COORD_NEEDED", "UNKNOWN" ]

  The specificity of the nomenclature. Values are only returned when the groupType is Problem.
• terminology(required): string
  The medical terminology that this nomenclature belongs to.

{
    "type":"object",
    "description":"The details of a returned nomenclature entry.",
    "required":[
        "id",
        "displayName",
        "terminology"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the nomenclature in the context of the authority."
        },
        "displayName":{
            "type":"string",
            "description":"The display or description from the content source."
        },
        "terminology":{
            "type":"string",
            "description":"The medical terminology that this nomenclature belongs to."
        },
        "code":{
            "type":"string",
            "description":"The unique code given to the term by the terminology."
        },
        "crossMappedNomenclatures":{
            "type":"array",
            "description":"Nomenclatures from other medical terminologies that are cross-mapped to this nomenclature. A cross-mapped nomenclature is an equivalent term from a more or less specific medical terminology. This field may be empty. Values are only returned when the groupType is Problem.",
            "items":{
                "$ref":"#/definitions/CrossMappedNomenclature"
            }
        },
        "specificity":{
            "type":"string",
            "description":"The specificity of the nomenclature. Values are only returned when the groupType is Problem.",
            "enum":[
                "POST_COORD_NEEDED",
                "UNKNOWN"
            ]
        },
        "isFavorite":{
            "type":"boolean",
            "description":"Indicator specifying that the nomenclature is a favorite nomenclature. Values are only returned when the groupType is Problem."
        }
    },
    "example":{
        "id":"1234abc",
        "displayName":"coronary artery bypass",
        "terminology":"CERNER_US_CPT4_PROCEDURES"
    }
}

Example:

{
    "id":"1234abc",
    "displayName":"coronary artery bypass",
    "terminology":"CERNER_US_CPT4_PROCEDURES"
}

Nested Schema : crossMappedNomenclatures

Type: array

Nomenclatures from other medical terminologies that are cross-mapped to this nomenclature. A cross-mapped nomenclature is an equivalent term from a more or less specific medical terminology. This field may be empty. Values are only returned when the groupType is Problem.

Show Source

• Array of: object CrossMappedNomenclature
  The details of a nomenclature that exists as a cross mapping of a source nomenclature.

{
    "type":"array",
    "description":"Nomenclatures from other medical terminologies that are cross-mapped to this nomenclature. A cross-mapped nomenclature is an equivalent term from a more or less specific medical terminology. This field may be empty. Values are only returned when the groupType is Problem.",
    "items":{
        "$ref":"#/definitions/CrossMappedNomenclature"
    }
}

Nested Schema : CrossMappedNomenclature

Type: object

The details of a nomenclature that exists as a cross mapping of a source nomenclature.

Show Source

• category: string
  Allowed Values: [ "PREFERRED_PRIMARY", "OTHER_PREFERRED_PRIMARY", "PREFERRED_SECONDARY", "ALTERNATE_SECONDARY" ]

  The category of this cross mapping.
• code: string
  The vendor-specific codified value for this nomenclature.
• riskIndicators: array riskIndicators
  A list of risk indicators for the nomenclature.
• terminology: string
  The medical terminology that this cross-mapped nomenclature belongs too.

{
    "type":"object",
    "description":"The details of a nomenclature that exists as a cross mapping of a source nomenclature.",
    "properties":{
        "code":{
            "type":"string",
            "description":"The vendor-specific codified value for this nomenclature."
        },
        "terminology":{
            "type":"string",
            "description":"The medical terminology that this cross-mapped nomenclature belongs too."
        },
        "riskIndicators":{
            "type":"array",
            "description":"A list of risk indicators for the nomenclature.",
            "items":{
                "$ref":"#/definitions/RiskIndicator"
            }
        },
        "category":{
            "type":"string",
            "description":"The category of this cross mapping.",
            "enum":[
                "PREFERRED_PRIMARY",
                "OTHER_PREFERRED_PRIMARY",
                "PREFERRED_SECONDARY",
                "ALTERNATE_SECONDARY"
            ]
        }
    },
    "example":{
        "code":"W56.21XS",
        "terminology":"ICD10-CM",
        "riskIndicators":{
            "type":"HCC",
            "code":"167",
            "description":"Major Head Injury"
        },
        "category":"PREFERRED_PRIMARY"
    }
}

Example:

{
    "code":"W56.21XS",
    "terminology":"ICD10-CM",
    "riskIndicators":{
        "type":"HCC",
        "code":"167",
        "description":"Major Head Injury"
    },
    "category":"PREFERRED_PRIMARY"
}

Nested Schema : riskIndicators

Type: array

A list of risk indicators for the nomenclature.

Show Source

• Array of: object RiskIndicator
  The details of a risk indicator.

{
    "type":"array",
    "description":"A list of risk indicators for the nomenclature.",
    "items":{
        "$ref":"#/definitions/RiskIndicator"
    }
}

Nested Schema : RiskIndicator

Type: object

The details of a risk indicator.

Show Source

• code: string
  The codified value of the risk indicator.
• description: string
  A description of this particular risk indicator.
• type: string
  Allowed Values: [ "HCC" ]

  The risk indicator type.

{
    "type":"object",
    "description":"The details of a risk indicator.",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "HCC"
            ],
            "description":"The risk indicator type."
        },
        "code":{
            "type":"string",
            "description":"The codified value of the risk indicator."
        },
        "description":{
            "type":"string",
            "description":"A description of this particular risk indicator."
        }
    },
    "example":{
        "type":"HCC",
        "code":"167",
        "description":"Major Head Injury"
    }
}

Example:

{
    "type":"HCC",
    "code":"167",
    "description":"Major Head Injury"
}

400 Response

Bad Request

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

403 Response

NotAuthorized

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

412 Response

Precondition Failed

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

429 Response

Too Many Requests

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Headers

• 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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• 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.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any errors from the resulting service call.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any errors from the resulting service call.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any errors from the resulting service call.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• 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.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• 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.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers which caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers which caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"<p>A list of JSON Pointers (<a href=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error.</p>\n<p>For example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON pointer must \npoint to a value in the request document that exists; if it does not, ignore the pointer.</p>\n",
    "items":{
        "type":"string"
    }
}

Back to Top