Oracle Health EHR APIs for Oracle Health Millennium Platform

Get a list of messages received by a patient

get

/20241001/patientMessages/inboxItems

Retrieves a list of received messages based on the given patient ID.
Note: The service currently supports the return of 1 page with a maximum of 1000 messages. To return further items, adjust the date and time parameters.

Request

Query Parameters

createDateTimeGreaterThanOrEqualTo: string

Messages created after this date and time value will be retrieved.

Reminders set to show up after this date and time will be retrieved.

Defaults to 90 days before the current date and time. Must be before the createDateTimeLessThanOrEqualTo.

The ISO 8601 Combined Date and Time in UTC point-in-time format is used to specify the date and time value, excluding milliseconds.
createDateTimeLessThanOrEqualTo: string

Messages created before this date and time value will be retrieved.

Reminders set to show up before this date and time will be retrieved.

Defaults to the current date and time. Must be after the createDateTimeGreaterThanOrEqualTo.

Future dates are not supported and if provided, the default current date and time will be used instead.

The ISO 8601 Combined Date and Time in UTC point-in-time format is used to specify the date and time value, excluding milliseconds.
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
notificationType: array[string]
Collection Format: multi

The type of messages to be retrieved. Defaults to [ MESSAGE ].
- Allowed Values: [ "MESSAGE", "REMINDER" ]
page: string

Minimum Length: 1

For list pagination. The value of the opc-next-page response header from the previous List request.
patientId(required): string

Identifier of patient to filter the resource query against.
shouldLoadOrganizationSummary: boolean

If true, inbox item list and message details by ID populate the organization object, which includes ID, display, and orgTypes.

Default Value: false
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for createDateTime is descending.

Sort the patient messages by createDateTime for sent items.

Sort the reminders by remindDateTime and the messages by createDateTime for inbox items.

Default Value: createDateTime

Allowed Values: [ "createDateTime", "priority" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: DESC

Allowed Values: [ "ASC", "DESC" ]
status: array[string]
Collection Format: multi

A comma delimited status string of messages to be retrieved. Defaults to [ OPENED, UNREAD ].
- Allowed Values: [ "OPENED", "UNREAD", "DELETED" ]

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.

Response

Supported Media Types

application/json

200 Response

Success

Headers

opc-next-page: string

For list pagination. When this header appears in the response, additional pages of results remain.
opc-prev-page: string

For list pagination. When this header appears in the response, additional pages of results remain.
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.

Root Schema : PatientInboxMessagesCollection

Type: object

Listing of messages that have been received by the patient.

Show Source

hasAdditionalListItems(required): boolean

An indicator tells whether any more messages existed for the given filtering criteria.
items(required): array items

List of the received patient messages retrieved. This value can be empty.

{
    "type":"object",
    "description":"Listing of messages that have been received by the patient.",
    "required":[
        "items",
        "hasAdditionalListItems"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of the received patient messages retrieved. This value can be empty.",
            "items":{
                "$ref":"#/definitions/PatientInboxMessageSummary"
            }
        },
        "hasAdditionalListItems":{
            "type":"boolean",
            "description":"An indicator tells whether any more messages existed for the given filtering criteria."
        }
    }
}

Nested Schema : items

Type: array

List of the received patient messages retrieved. This value can be empty.

Show Source

Array of: object PatientInboxMessageSummary

Representation of an inbox message for a patient.

{
    "type":"array",
    "description":"List of the received patient messages retrieved. This value can be empty.",
    "items":{
        "$ref":"#/definitions/PatientInboxMessageSummary"
    }
}

Nested Schema : PatientInboxMessageSummary

Type: object

Representation of an inbox message for a patient.

Show Source

carbonCopyRecipients: array carbonCopyRecipients

List of the personnel and group inboxes who received a copy of the message.
conversationId(required): string

The identifier of the conversation.

All messages are assigned a conversationId, even if no replies have taken place.

Multiple messages can have the same conversation ID if they are part of the same thread or back and forth of replies.

This value allows the consumer to group the messages together visually in a thread.
createdDateTime(required): object DateTimeWithZone

Representation of date and time with the time zone.
dueDateTime: object DateTimeWithZone

Representation of date and time with the time zone.
encounter: object Encounter

The encounter associated with the message.
hasAttachments(required): boolean

Indicator that indicates if this message has any attachment.
id(required): string

The identifier for the received message.
messageSender(required): object SenderSummary

Sender of the message.
notificationStatus(required): object NotificationStatus

Information about the status of a message.
notificationType(required): object NotificationType

Information about the message type.
notificationVersion(required): integer

The task version for the message.
patient(required): object PersonSimple

A simple representation of the individual person that was retrieved.

The individual could be a personnel member (provider), a patient, or a non-patient person.
previousItemId: string

The identifier for the previous received message if replied.
priority(required): object Priority

The priority of the message.
recipientNotificationVersion(required): integer

The receiver version for the message.
recipients(required): array recipients

List of the person, personnel, and group inboxes who are the recipient of the message.
remindDateTime: object DateTimeWithZone

Representation of date and time with the time zone.
subject: string

The subject of the received message.
updatedDateTime(required): object DateTimeWithZone

Representation of date and time with the time zone.

{
    "type":"object",
    "description":"Representation of an inbox message for a patient.",
    "required":[
        "id",
        "patient",
        "conversationId",
        "createdDateTime",
        "updatedDateTime",
        "priority",
        "notificationStatus",
        "notificationType",
        "hasAttachments",
        "notificationVersion",
        "recipientNotificationVersion",
        "recipients",
        "messageSender"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier for the received message."
        },
        "patient":{
            "$ref":"#/definitions/PersonSimple",
            "description":"The patient who is the subject of the message or the message is about."
        },
        "encounter":{
            "$ref":"#/definitions/Encounter",
            "description":"The encounter associated with the message."
        },
        "conversationId":{
            "type":"string",
            "description":"<p>The identifier of the conversation.</p>\n<p>All messages are assigned a conversationId, even if no replies have taken place.</p>\n<p>Multiple messages can have the same conversation ID if they are part of the same thread or back and forth of replies.</p>\n<p>This value allows the consumer to group the messages together visually in a thread.</p>\n"
        },
        "previousItemId":{
            "type":"string",
            "description":"The identifier for the previous received message if replied."
        },
        "subject":{
            "type":"string",
            "description":"The subject of the received message."
        },
        "createdDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"<p>The date and time that the message was created.</p>\n<p>The ISO 8601 Combined Date and Time in UTC format is used to specify the date and time value, excluding milliseconds.</p>\n"
        },
        "updatedDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"<p>The date and time that the message was last updated.</p>\n<p>The ISO 8601 Combined Date and Time in UTC format is used to specify the date and time value, excluding milliseconds.</p>\n"
        },
        "remindDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"<p>The date and time that the reminder should appear.</p>\n<p>The ISO 8601 Combined Date and Time in UTC format is used to specify the date and time value, excluding milliseconds.</p>\n"
        },
        "dueDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"<p>The date and time that the message becomes due.</p>\n<p>The ISO 8601 Combined Date and Time in UTC format is used to specify the date and time value, excluding milliseconds.</p>\n"
        },
        "priority":{
            "$ref":"#/definitions/Priority",
            "description":"The priority of the received message."
        },
        "notificationStatus":{
            "$ref":"#/definitions/NotificationStatus",
            "description":"The status of the received message."
        },
        "notificationType":{
            "$ref":"#/definitions/NotificationType",
            "description":"The type of the received message."
        },
        "hasAttachments":{
            "type":"boolean",
            "description":"Indicator that indicates if this message has any attachment."
        },
        "notificationVersion":{
            "type":"integer",
            "description":"The task version for the message."
        },
        "recipientNotificationVersion":{
            "type":"integer",
            "description":"The receiver version for the message."
        },
        "recipients":{
            "type":"array",
            "description":"List of the person, personnel, and group inboxes who are the recipient of the message.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "carbonCopyRecipients":{
            "type":"array",
            "description":"List of the personnel and group inboxes who received a copy of the message.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "messageSender":{
            "$ref":"#/definitions/SenderSummary",
            "description":"The personnel or group inbox who sent the message."
        }
    }
}

Nested Schema : carbonCopyRecipients

Type: array

List of the personnel and group inboxes who received a copy of the message.

Show Source

Array of: object Participant

Sender or recipient of the message.

{
    "type":"array",
    "description":"List of the personnel and group inboxes who received a copy of the message.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : DateTimeWithZone

Type: object

Representation of date and time with the time zone.

Show Source

dateTime: string(date-time)

The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339.

No time zone information is associated with this date and time.
ianaTimeZone: string

The time zone, provided that the date includes time precision. If dateTime contains time, this value is required.

{
    "type":"object",
    "description":"Representation of date and time with the time zone.",
    "properties":{
        "dateTime":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.</p>\n<p>No time zone information is associated with this date and time.</p>\n"
        },
        "ianaTimeZone":{
            "type":"string",
            "description":"The time zone, provided that the date includes time precision. If <code>dateTime</code> contains time, this value is required."
        }
    }
}

Nested Schema : Encounter

Type: object

The encounter associated with the message.

Show Source

id(required): string

The unique identifier for the encounter.
organization: object Organization

The organization associated with the patient and encounter.

Only loaded for inbox list and message details views when the OptionalShouldLoadOrganizationSummary is set.

{
    "type":"object",
    "description":"The encounter associated with the message.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the encounter."
        },
        "organization":{
            "$ref":"#/definitions/Organization",
            "description":"The organization associated with the encounter."
        }
    }
}

Nested Schema : SenderSummary

Type: object

Sender of the message.

Show Source

groupInboxSummary: object GroupInboxSummary

Summary of the group inbox sender.
id(required): string

The unique identifier for the participant.
personName: object PersonNameSummary

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
personnelName: object PersonNameSummary

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
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.
- Set to PERSONNEL or GROUPINBOX for inbox item sender.

{
    "type":"object",
    "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  <li>Set to PERSONNEL or GROUPINBOX for inbox item sender.</li>\n</ul>\n",
            "enum":[
                "PERSON",
                "PERSONNEL",
                "GROUPINBOX"
            ]
        },
        "personName":{
            "description":"The name of the person, for cases where the participant is of type person.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "personnelName":{
            "description":"The name of the personnel member, for cases where the participant is of type personnel.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "groupInboxSummary":{
            "description":"The details of the group inbox, for cases where the participant is of type group inbox.",
            "$ref":"#/definitions/GroupInboxSummary"
        }
    },
    "description":"Sender of the message."
}

Nested Schema : NotificationStatus

Type: object

Information about the status of a message.

Show Source

value(required): string

Allowed Values: [ "UNREAD", "OPENED", "DELETED", "UNKNOWN" ]

The status of the message.

{
    "type":"object",
    "description":"Information about the status of a message.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The status of the message.",
            "enum":[
                "UNREAD",
                "OPENED",
                "DELETED",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : NotificationType

Type: object

Information about the message type.

Show Source

value(required): string

Allowed Values: [ "MESSAGE", "REMINDER", "UNKNOWN" ]

The type of message.

{
    "type":"object",
    "description":"Information about the message type.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The type of message.",
            "enum":[
                "MESSAGE",
                "REMINDER",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : PersonSimple

Type: object

A simple representation of the individual person that was retrieved.

The individual could be a personnel member (provider), a patient, or a non-patient person.

Show Source

id(required): string

The unique identifier for the individual.
name: object PersonNameSummary

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.

{
    "description":"<p>A simple representation of the individual person that was retrieved.</p>\n<p>The individual could be a personnel member (provider), a patient, or a non-patient person.</p>\n",
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier for the individual.",
            "type":"string"
        },
        "name":{
            "description":"The name of the individual.",
            "$ref":"#/definitions/PersonNameSummary"
        }
    }
}

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 the person, personnel, and group inboxes who are the recipient of the message.

Show Source

Array of: object Participant

Sender or recipient of the message.

{
    "type":"array",
    "description":"List of the person, personnel, and group inboxes who are the recipient of the message.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : Participant

Type: object

Sender or recipient of the message.

Show Source

groupInboxName: string

The name of the group inbox, for cases where the participant is of type group inbox.
id(required): string

The unique identifier for the participant.
personName: object PersonNameSummary

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
personnelName: object PersonNameSummary

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.
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, and inbox item carbon copy recipients.
- Set to PERSON, PERSONNEL, or GROUPINBOX for inbox item recipients.

{
    "type":"object",
    "description":"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, and inbox item carbon copy recipients.</li>\n  <li>Set to PERSON, PERSONNEL, or GROUPINBOX for inbox item recipients.</li>\n</ul>\n",
            "enum":[
                "PERSON",
                "PERSONNEL",
                "GROUPINBOX"
            ]
        },
        "personName":{
            "description":"The name of the person, for cases where the participant is of type person.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "personnelName":{
            "description":"The name of the personnel member, for cases where the participant is of type personnel.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "groupInboxName":{
            "type":"string",
            "description":"The name of the group inbox, for cases where the participant is of type group inbox."
        }
    }
}

Nested Schema : PersonNameSummary

Type: object

A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.

Show Source

firstName: string

The person's first given name.
fullName: string

The fully formatted name.
lastName: string

The person's family last name.

{
    "description":"A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"The person's first given name.",
            "type":"string"
        },
        "lastName":{
            "description":"The person's family last name.",
            "type":"string"
        },
        "fullName":{
            "description":"The fully formatted name.",
            "type":"string"
        }
    }
}

Nested Schema : Organization

Type: object

The organization associated with the patient and encounter.

Only loaded for inbox list and message details views when the OptionalShouldLoadOrganizationSummary is set.

Show Source

display: string

The display name for the organization.
id(required): string

The unique identifier for the organization.
orgTypes: array orgTypes

List of the organization types.

{
    "type":"object",
    "description":"<p>The organization associated with the patient and encounter.</p>\n<p>Only loaded for inbox list and message details views when the OptionalShouldLoadOrganizationSummary is set.</p>\n",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the organization."
        },
        "display":{
            "type":"string",
            "description":"The display name for the organization."
        },
        "orgTypes":{
            "type":"array",
            "description":"List of the organization types.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : orgTypes

Type: array

List of the organization types.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of the organization types.",
    "items":{
        "type":"string"
    }
}

Nested Schema : GroupInboxSummary

Type: object

Summary of the group inbox sender.

Show Source

groupInboxName(required): string

The name of the group inbox.
personnelSender: object PersonSimple

A simple representation of the individual person that was retrieved.

The individual could be a personnel member (provider), a patient, or a non-patient person.

{
    "type":"object",
    "required":[
        "groupInboxName"
    ],
    "properties":{
        "groupInboxName":{
            "type":"string",
            "description":"The name of the group inbox."
        },
        "personnelSender":{
            "$ref":"#/definitions/PersonSimple",
            "description":"The sender who sent the message from the group inbox."
        }
    },
    "description":"Summary of the group inbox sender."
}

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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