Oracle Health EHR APIs for Oracle Health Millennium Platform

Get a list of chief complaints for a patient

get

/20240101/chiefComplaints

Retrieves chief complaints for a patient that you can filter by the patient's encounter.

Chief complaints are only documented once per patient encounter. If the encounterId filter is set and a chief complaint exists for the encounter, the system returns only one response.

Note: The encounterId filter is required until retrieving all chief complaints for a patient is supported.

Request

Query Parameters

encounterId(required): string

The unique identifier of the patient's encounter.
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
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

The unique identifier of the patient.

Header Parameters

authorization(required): string

Contains the credentials to authenticate a consumer to the service.
opc-request-id: string

Unique Oracle Health assigned identifier for the request. If you need to contact Oracle about a particular request, 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

Headers

oh-next-page: string

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

Type: object

The response from the list chief complaints operation.

Show Source

items(required): array items

A collection of chief complaint summaries from the list chief complaints operation.

{
    "type":"object",
    "description":"The response from the list chief complaints operation.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A collection of chief complaint summaries from the list chief complaints operation.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChiefComplaintSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A collection of chief complaint summaries from the list chief complaints operation.

Show Source

Array of: object ChiefComplaintSummary

A summary of a patient's chief complaint for an encounter.

{
    "description":"A collection of chief complaint summaries from the list chief complaints operation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChiefComplaintSummary"
    }
}

Nested Schema : ChiefComplaintSummary

Type: object

A summary of a patient's chief complaint for an encounter.

Show Source

display(required): string

The displayable representation of the chief complaint.

Example: Ankle sprain
effectiveDateTime(required): string

The date and time the chief complaint became effective for the patient. In UTC time and ISO 8601 format.

Example: 2023-09-29T11:20:09Z
encounterId(required): string

The unique identifier of the encounter that the chief complaint is for.

Example: 97787429
id(required): string

The unique identifier of the chief complaint.

Example: 189786617
patientId(required): string

The unique identifier of the patient that the chief complaint is for.

Example: 12552026

{
    "description":"A summary of a patient's chief complaint for an encounter.",
    "required":[
        "id",
        "display",
        "effectiveDateTime",
        "patientId",
        "encounterId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier of the chief complaint.",
            "example":"189786617",
            "type":"string"
        },
        "display":{
            "description":"The displayable representation of the chief complaint.",
            "example":"Ankle sprain",
            "type":"string"
        },
        "effectiveDateTime":{
            "description":"The date and time the chief complaint became effective for the patient. In UTC time and ISO 8601 format.",
            "example":"2023-09-29T11:20:09Z",
            "type":"string"
        },
        "patientId":{
            "description":"The unique identifier of the patient that the chief complaint is for.",
            "example":"12552026",
            "type":"string"
        },
        "encounterId":{
            "description":"The unique identifier of the encounter that the chief complaint is for.",
            "example":"97787429",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 and all errors from the resulting service request.
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 and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

Array of: object ErrorDetail

Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "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 that 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 exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\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 that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of the request headers that 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 exist, the client should ignore the pointer.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 and all errors from the resulting service request.
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 and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

Array of: object ErrorDetail

Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "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 that 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 exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\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 that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of the request headers that 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

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 and all errors from the resulting service request.
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 and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

Array of: object ErrorDetail

Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "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 that 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 exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\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 that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of the request headers that 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

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 and all errors from the resulting service request.
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 and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

Array of: object ErrorDetail

Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "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 that 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 exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\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 that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of the request headers that 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

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 and all errors from the resulting service request.
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 and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

Array of: object ErrorDetail

Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "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 that 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 exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\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 that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of the request headers that 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

Show Source

Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor 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 exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}