Jump to

• Request
• Response

Send a message to a set of recipients

post

/20241001/patientMessages/sentItems

Creates a message to a set of recipients.

Consumers can reply to a message by populating the PreviousMessageId with the identifier of the message being replied to.

Request

Header Parameters

• accept: string
  Specifies which media types are acceptable for the response. Defaults to application/json.

  Default Value: application/json
• accept-charset: string
  Specifies which character sets are acceptable for the response. Defaults to UTF-8.

  Default Value: UTF-8
• 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.

Body ()

Details about the message to be sent.

Root Schema : CreateSentItemDetails

Type: object

Detailed information about a message to create.

Show Source

• attachments: array attachments
  The list of attachments on the message.
• carbonCopyRecipients: array carbonCopyRecipients
  List of carbon copy receivers.
• content(required): string
  The content of the message in XHTML format.
• messageSender(required): object ParticipantSimple
  Simplified information about the sender or recipient of the message.
• patientId(required): string
  Identifier of the patient who is the subject of the message or the message is about.
• previousMessageId: string

  Identifier of the previous message in the conversation that this new message is in reply to.

  Cannot reply to a REMINDER.

  Previous message must have the same encounter and responsiblePersonnelId if those fields are also provided. If they are not provided, they are carried forward automatically.

• priority: object Priority
  The priority of the message.
• recipients(required): array recipients
  List of receivers. Required to have at least one recipient.
• subject: string

  The subject of the message.

  It is recommended that replies begin with Re: and forwarded messages begin with Fw:.

{
    "type":"object",
    "description":"Detailed information about a message to create.\n",
    "required":[
        "messageSender",
        "content",
        "patientId",
        "recipients"
    ],
    "properties":{
        "messageSender":{
            "$ref":"#/definitions/ParticipantSimple",
            "description":"Details about the sender."
        },
        "content":{
            "type":"string",
            "description":"The content of the message in XHTML format.\n"
        },
        "subject":{
            "type":"string",
            "description":"<p>The subject of the message.</p>\n<p>It is recommended that replies begin with <b>Re:</b> and forwarded messages begin with <b>Fw:</b>.</p>\n"
        },
        "patientId":{
            "type":"string",
            "description":"Identifier of the patient who is the subject of the message or the message is about."
        },
        "recipients":{
            "type":"array",
            "description":"List of receivers. Required to have at least one recipient.",
            "items":{
                "$ref":"#/definitions/ParticipantSimple"
            }
        },
        "carbonCopyRecipients":{
            "type":"array",
            "description":"List of carbon copy receivers.",
            "items":{
                "$ref":"#/definitions/ParticipantSimple"
            }
        },
        "attachments":{
            "type":"array",
            "description":"The list of attachments on the message.",
            "items":{
                "$ref":"#/definitions/Attachment"
            }
        },
        "priority":{
            "$ref":"#/definitions/Priority",
            "description":"The priority of the message."
        },
        "previousMessageId":{
            "type":"string",
            "description":"<p>Identifier of the previous message in the conversation that this new message is in reply to.</p>\n<p>Cannot reply to a REMINDER.</p>\n<p>Previous message must have the same encounter and responsiblePersonnelId if those fields are also provided. If they are not provided,\nthey are carried forward automatically.</p>\n"
        }
    }
}

Nested Schema : attachments

Type: array

The list of attachments on the message.

Show Source

• Array of: object Attachment
  Details about a message attachment.

{
    "type":"array",
    "description":"The list of attachments on the message.",
    "items":{
        "$ref":"#/definitions/Attachment"
    }
}

Nested Schema : carbonCopyRecipients

Type: array

List of carbon copy receivers.

Show Source

• Array of: object ParticipantSimple
  Simplified information about the sender or recipient of the message.

{
    "type":"array",
    "description":"List of carbon copy receivers.",
    "items":{
        "$ref":"#/definitions/ParticipantSimple"
    }
}

Nested Schema : ParticipantSimple

Type: object

Simplified information about the sender or recipient of the message.

Show Source

• id(required): string
  The unique identifier for the participant.
• type(required): string
  Allowed Values: [ "PERSON", "PERSONNEL", "GROUPINBOX" ]

  The type of the participant. This field must be set.

  • Set to PERSON for sent item sender.
  • Set to PERSONNEL or GROUPINBOX for sent item recipients.

{
    "type":"object",
    "description":"Simplified information about the sender or recipient of the message.",
    "required":[
        "id",
        "type"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the participant."
        },
        "type":{
            "type":"string",
            "description":"The type of the participant. This field must be set.\n<ul>\n  <li>Set to PERSON for sent item sender.</li>\n  <li>Set to PERSONNEL or GROUPINBOX for sent item recipients.</li>\n</ul>\n",
            "enum":[
                "PERSON",
                "PERSONNEL",
                "GROUPINBOX"
            ]
        }
    }
}

Nested Schema : Priority

Type: object

The priority of the message.

Show Source

• value(required): string
  Allowed Values: [ "HIGH", "NORMAL" ]

  The value of the priority. HIGH denotes STAT. NORMAL denotes ROUTINE.

{
    "type":"object",
    "description":"The priority of the message.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The value of the priority.\nHIGH denotes STAT.\nNORMAL denotes ROUTINE.\n",
            "enum":[
                "HIGH",
                "NORMAL"
            ]
        }
    }
}

Nested Schema : recipients

Type: array

List of receivers. Required to have at least one recipient.

Show Source

• Array of: object ParticipantSimple
  Simplified information about the sender or recipient of the message.

{
    "type":"array",
    "description":"List of receivers. Required to have at least one recipient.",
    "items":{
        "$ref":"#/definitions/ParticipantSimple"
    }
}

Nested Schema : Attachment

Type: object

Details about a message attachment.

Show Source

• id(required): string
  The identifier of the attachment.
• name(required): string
  The name of the attachment.
• version(required): integer
  The version of the attachment.

{
    "type":"object",
    "description":"Details about a message attachment.",
    "required":[
        "name",
        "id",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the attachment."
        },
        "id":{
            "type":"string",
            "description":"The identifier of the attachment."
        },
        "version":{
            "type":"integer",
            "description":"The version of the attachment."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• 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 : PatientSentMessage

Type: object

Information about the message that was sent.

Show Source

• id(required): string
  The identifier of the sent message.

{
    "type":"object",
    "description":"Information about the message that was sent.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the sent message."
        }
    }
}

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

404 Response

Not Found

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

409 Response

Conflict

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

422 Response

Unprocessable Entity

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

Default Response

Unknown 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