Oracle Health EHR APIs for Oracle Health Millennium Platform

Get a condition by condition identifier

get

/20240101/conditions/{conditionId}

Retrieves a condition by condition identifier.

Request

Path Parameters

conditionId(required): string

The unique identifier for the condition to retrieve.

Query Parameters

encounterId: string

The encounter ID to filter the resource query against.
patientId(required): string

The patient ID to filter the resource query against.

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

Success.

Headers

etag: string

For optimistic concurrency control. See if-match.
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 : Condition

The response model for the detailed condition response.

Match All

The response model for the detailed condition response.

Show Source

allOf ConditionBase

A base model object with common properties in a condition.
object Condition-allOf[1]

{
    "description":"The response model for the detailed condition response.",
    "allOf":[
        {
            "$ref":"#/definitions/ConditionBase"
        },
        {
            "type":"object",
            "properties":{
                "mostRecentReview":{
                    "description":"The most recent assessment of the condition.",
                    "$ref":"#/definitions/ConditionReview"
                },
                "entityList":{
                    "description":"The list of the individual acute and chronic entities that make up the condition.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Entity"
                    }
                },
                "summary":{
                    "description":"The clinical summary associated with the condition.",
                    "$ref":"#/definitions/Summary"
                },
                "commentList":{
                    "description":"The list of comments for the condition in reverse chronological order.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Comment"
                    }
                }
            }
        }
    ]
}

Nested Schema : ConditionBase

A base model object with common properties in a condition.

Match All

A base model object with common properties in a condition.

Show Source

object EntityBase

Contains common properties across entity and conditions.
object ConditionBase-allOf[1]

{
    "description":"A base model object with common properties in a condition.",
    "allOf":[
        {
            "$ref":"#/definitions/EntityBase"
        },
        {
            "type":"object",
            "required":[
                "id"
            ],
            "properties":{
                "id":{
                    "description":"The unique identifier for the condition.",
                    "type":"string",
                    "example":"CODIFIED_123_456"
                },
                "displayName":{
                    "description":"The name of patient's condition, for example, <code>anemia</code>.",
                    "type":"string",
                    "example":"Anemia"
                },
                "specificity":{
                    "description":"The specificity of the condition's acute nomenclature. Typically populated when the \ncondition is associated with this visit, but use caution when consuming this enum in case \nit is not populated or has a value other than those listed.\n",
                    "type":"string",
                    "enum":[
                        "SPECIFIED",
                        "NOT_SPECIFIED",
                        "NOT_ACTIONABLE"
                    ]
                },
                "acuteDate":{
                    "description":"The ISO-8601 representation of the acute diagnosis date associated with the condition. \nThis representation is only applicable to an acute condition and does not include any time information.\n",
                    "type":"string",
                    "format":"date",
                    "example":"2016-10-20"
                },
                "sensitivity":{
                    "$ref":"#/definitions/Sensitivity"
                }
            }
        }
    ]
}

Nested Schema : EntityBase

Type: object

Contains common properties across entity and conditions.

Show Source

acuteNomenclature: object NomenclatureSimple

The model object for a nomenclature.
acuteType: object CodeValueSimple

A minimal representation of a code value.
chronicNomenclature: object NomenclatureSimple

The model object for a nomenclature.
chronicStatus: object CodeValueSimple

A minimal representation of a code value.
classification: object CodeValueSimple

A minimal representation of a code value.
confirmation: object CodeValueSimple

A minimal representation of a code value.
createdBy: object PersonSimple

A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
laterality: object CodeValueSimple

A minimal representation of a code value.
nomenclature: object NomenclatureSimple

The model object for a nomenclature.
onsetDate: object FuzzyDate

The model object for a fuzzy date associated with a clinical concept with a corresponding precision and unit applied to it. The precision and unit are used with the provided date to communicate a possibly imprecise date, for example, Age 28 or Sometime After 2020-04. Note that the /referenceData for a given API should be queried to confirm exactly which FuzzyDateUnit or FuzzyDatePrecision values are supported by that API.
resolutionDate: object FuzzyDate

The model object for a fuzzy date associated with a clinical concept with a corresponding precision and unit applied to it. The precision and unit are used with the provided date to communicate a possibly imprecise date, for example, Age 28 or Sometime After 2020-04. Note that the /referenceData for a given API should be queried to confirm exactly which FuzzyDateUnit or FuzzyDatePrecision values are supported by that API.

{
    "description":"Contains common properties across entity and conditions.",
    "type":"object",
    "properties":{
        "acuteType":{
            "description":"The acute type of the condition. Only applicable to a condition with at least one acute entity. Examples include <code>Billing</code>, <code>Working</code>, and <code>Final</code>.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "laterality":{
            "description":"The side of the body on which a condition occurs. Laterality is used to specify whether a disease or condition \naffects the left, right, or both sides of the body. This concept is important in diagnosing \nand treating conditions that can occur asymmetrically, meaning that they affect only one side of the body. \nCommon examples include conditions such as unilateral limb paralysis, unilateral hearing loss, or diseases \naffecting organs that come in pairs, such as the kidneys or lungs.\n",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "classification":{
            "description":"<p>Clinical conditions can be classified based on various criteria to aid in diagnosis, treatment, and research. \nConditions can be categorized by etiology, such as infectious, non-infectious, or autoimmune diseases. \nThey may also be classified by pathophysiology, distinguishing between degenerative, metabolic, or \nneoplastic diseases.</p>\n<p>Severity and the course of the disease also play roles in classification, with distinctions between \nacute, chronic, and progressive conditions. Additionally, conditions are often classified according to the \naffected body system, symptomatology, diagnostic criteria, and genetic influences.</p>\n",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "confirmation":{
            "description":"<p>The confirmation status of the condition.</p>\n<p>Examples include <code>Possible</code>, <code>Probable</code>, and <code>Confirmed</code>.</p>\n",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "nomenclature":{
            "description":"Represents the source nomenclature that associates all the problems and diagnoses within the condition together.",
            "$ref":"#/definitions/NomenclatureSimple"
        },
        "chronicNomenclature":{
            "description":"If chronic, provides an identifier for the type of chronic issue that this entity represents.",
            "$ref":"#/definitions/NomenclatureSimple"
        },
        "acuteNomenclature":{
            "description":"If acute, provides an identifier for the type of acute issue that this entity represents. An item may have\nboth <code>acuteNomenclature</code> and <code>chronicNomenclature</code>, which would imply that the issue was started as acute and \nprogressed towards chronic.\n",
            "$ref":"#/definitions/NomenclatureSimple"
        },
        "chronicStatus":{
            "description":"<p>The lifecycle status of a chronic condition. The lifecycle of a clinical condition encompasses various \nstates or stages that a condition may go through from its identification to its resolution or management. </p>\n<p>Examples are <code>onset</code>, <code>diagnosis</code>, <code>active</code>, <code>monitoring</code>, \n<code>exacerbation</code>, <code>remission</code>, <code>resolved</code>, and so on.</p>\n",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "createdBy":{
            "description":"The original responsible provider who created this condition.",
            "$ref":"#/definitions/PersonSimple"
        },
        "resolutionDate":{
            "description":"The date that the condition's chronic status is resolved.",
            "$ref":"#/definitions/FuzzyDate"
        },
        "onsetDate":{
            "description":"The estimated or actual date that the condition began, in the opinion of the clinician.",
            "$ref":"#/definitions/FuzzyDate"
        }
    }
}

Nested Schema : ConditionBase-allOf[1]

Type: object

Show Source

acuteDate: string(date)

The ISO-8601 representation of the acute diagnosis date associated with the condition. This representation is only applicable to an acute condition and does not include any time information.

Example: 2016-10-20
displayName: string

The name of patient's condition, for example, anemia.

Example: Anemia
id(required): string

The unique identifier for the condition.

Example: CODIFIED_123_456
sensitivity: object Sensitivity

Sensitivity attributes are related to conditions that could be sensitive to expose, such as mental health details, sexually transmitted diseases, substance abuse history, or HIV status. Sensitivity labels help ensure that such information is handled with extra care, accessed only by authorized personnel, and not inadvertently disclosed.
specificity: string

Allowed Values: [ "SPECIFIED", "NOT_SPECIFIED", "NOT_ACTIONABLE" ]

The specificity of the condition's acute nomenclature. Typically populated when the condition is associated with this visit, but use caution when consuming this enum in case it is not populated or has a value other than those listed.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier for the condition.",
            "type":"string",
            "example":"CODIFIED_123_456"
        },
        "displayName":{
            "description":"The name of patient's condition, for example, <code>anemia</code>.",
            "type":"string",
            "example":"Anemia"
        },
        "specificity":{
            "description":"The specificity of the condition's acute nomenclature. Typically populated when the \ncondition is associated with this visit, but use caution when consuming this enum in case \nit is not populated or has a value other than those listed.\n",
            "type":"string",
            "enum":[
                "SPECIFIED",
                "NOT_SPECIFIED",
                "NOT_ACTIONABLE"
            ]
        },
        "acuteDate":{
            "description":"The ISO-8601 representation of the acute diagnosis date associated with the condition. \nThis representation is only applicable to an acute condition and does not include any time information.\n",
            "type":"string",
            "format":"date",
            "example":"2016-10-20"
        },
        "sensitivity":{
            "$ref":"#/definitions/Sensitivity"
        }
    }
}

Nested Schema : Condition-allOf[1]

Type: object

Show Source

commentList: array commentList

The list of comments for the condition in reverse chronological order.
entityList: array entityList

The list of the individual acute and chronic entities that make up the condition.
mostRecentReview: object ConditionReview

A review involves assessing the current status of the condition and determining whether it has improved, worsened, or remained stable. This assessment helps in deciding whether the ongoing treatment is effective or if adjustments are needed. Based on the review, treatment plans may be updated to better address the condition. An update might include changes in medication, therapy, or other interventions.
summary: object Summary

The model object representing a summary associated with a condition.

{
    "type":"object",
    "properties":{
        "mostRecentReview":{
            "description":"The most recent assessment of the condition.",
            "$ref":"#/definitions/ConditionReview"
        },
        "entityList":{
            "description":"The list of the individual acute and chronic entities that make up the condition.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Entity"
            }
        },
        "summary":{
            "description":"The clinical summary associated with the condition.",
            "$ref":"#/definitions/Summary"
        },
        "commentList":{
            "description":"The list of comments for the condition in reverse chronological order.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Comment"
            }
        }
    }
}

Nested Schema : NomenclatureSimple

Type: object

The model object for a nomenclature.

Show Source

code: string

The universal clinical code of the term.

Example: 452.5b
conceptCki: string

The concept CKI of the nomenclature.
displayName: string

The display of the nomenclature.

Example: Anemia Nomenclature
id(required): string

The unique identifier of the nomenclature.

Example: 1643574645
terminology: object CodeValueSimple

A minimal representation of a code value.
terminologyAxis: object CodeValueSimple

A minimal representation of a code value.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "example":"1643574645",
            "description":"The unique identifier of the nomenclature."
        },
        "displayName":{
            "type":"string",
            "example":"Anemia Nomenclature",
            "description":"The display of the nomenclature."
        },
        "code":{
            "type":"string",
            "example":"452.5b",
            "description":"The universal clinical code of the term."
        },
        "conceptCki":{
            "type":"string",
            "description":"The concept CKI of the nomenclature."
        },
        "terminology":{
            "description":"A code value representing the terminology (in other words, the vocabulary) that the nomenclature is associated with.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "terminologyAxis":{
            "description":"A code value representing the terminology axis of this concept, used to further segment where this concept falls within a terminology.",
            "$ref":"#/definitions/CodeValueSimple"
        }
    },
    "description":"The model object for a nomenclature."
}

Nested Schema : CodeValueSimple

Type: object

A minimal representation of a code value.

Show Source

cdfMeaning: string

A programmatic value, primarily used by applications to search for this value.
display: string

The text consumers see that represents this code value.
id(required): string

The ID of the code value.

{
    "description":"A minimal representation of a code value.",
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the code value.",
            "type":"string"
        },
        "display":{
            "description":"The text consumers see that represents this code value.",
            "type":"string"
        },
        "cdfMeaning":{
            "description":"A programmatic value, primarily used by applications to search for this value.",
            "type":"string"
        }
    }
}

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 nonpatient person.

Show Source

id(required): string

The unique identifier for the individual.
name: object PersonNameSummary

A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).

{
    "description":"A simple representation of the individual person that was retrieved.\nThe individual could be a personnel member (provider), a patient, or a nonpatient person.\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 : FuzzyDate

Type: object

The model object for a fuzzy date associated with a clinical concept with a corresponding precision and unit applied to it. The precision and unit are used with the provided date to communicate a possibly imprecise date, for example, Age 28 or Sometime After 2020-04. Note that the /referenceData for a given API should be queried to confirm exactly which FuzzyDateUnit or FuzzyDatePrecision values are supported by that API.

Show Source

date: string(date)

The date represented in YYYY-MM-DD format as defined by RFC 3339. No time zone information is associated with this date.
precision: object FuzzyDatePrecision

A code value representation of the precision associated with a date.
unit: object FuzzyDateUnit

A display and enumerated meaning structure representing date unit such as DAY, WEEK, MONTH, YEAR.

{
    "type":"object",
    "properties":{
        "unit":{
            "$ref":"#/definitions/FuzzyDateUnit"
        },
        "precision":{
            "$ref":"#/definitions/FuzzyDatePrecision"
        },
        "date":{
            "type":"string",
            "format":"date",
            "description":"The date represented in YYYY-MM-DD format as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\nNo time zone information is associated with this date.\n"
        }
    },
    "description":"The model object for a fuzzy date associated with a clinical concept with a corresponding precision and unit applied to it.\nThe precision and unit are used with the provided date to communicate a possibly imprecise date, for example,\nAge 28 or Sometime After 2020-04. Note that the /referenceData for a given API should be queried to confirm exactly which\nFuzzyDateUnit or FuzzyDatePrecision values are supported by that API.\n"
}

Nested Schema : PersonNameSummary

Type: object

A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient 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 just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient 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 : FuzzyDatePrecision

Type: object

A code value representation of the precision associated with a date.

Show Source

display(required): string

The display for the code value.

Example: Display
meaning: string

Allowed Values: [ "ABOUT", "AFTER", "AGE", "BEFORE", "UNKNOWN" ]

The enumerated meaning of the code value. Should almost always be populated, but use caution when consuming this enum in case it is not populated or has a value other than those listed.

{
    "type":"object",
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "example":"Display",
            "description":"The display for the code value."
        },
        "meaning":{
            "type":"string",
            "description":"The enumerated meaning of the code value. Should almost always be populated, but use caution when consuming this enum in case it is not populated or has a value other than those listed.",
            "enum":[
                "ABOUT",
                "AFTER",
                "AGE",
                "BEFORE",
                "UNKNOWN"
            ]
        }
    },
    "description":"A code value representation of the precision associated with a date."
}

Nested Schema : FuzzyDateUnit

Type: object

A display and enumerated meaning structure representing date unit such as DAY, WEEK, MONTH, YEAR.

Show Source

display(required): string

Display for the date unit.

Example: Date
meaning: string

Allowed Values: [ "DAY", "WEEK", "MONTH", "YEAR" ]

The enumerated meaning of the date unit. Should almost always be populated, but use caution when consuming this enum in case it is not populated or has a value other than those listed.

Example: DAY

{
    "type":"object",
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "example":"Date",
            "description":"Display for the date unit."
        },
        "meaning":{
            "type":"string",
            "example":"DAY",
            "description":"The enumerated meaning of the date unit. Should almost always be populated, but use caution when consuming this enum in case it is not populated or has a value other than those listed.",
            "enum":[
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR"
            ]
        }
    },
    "description":"A display and enumerated meaning structure representing date unit such as DAY, WEEK, MONTH, YEAR."
}

Nested Schema : Sensitivity

Type: object

Sensitivity attributes are related to conditions that could be sensitive to expose, such as mental health details, sexually transmitted diseases, substance abuse history, or HIV status. Sensitivity labels help ensure that such information is handled with extra care, accessed only by authorized personnel, and not inadvertently disclosed.

Show Source

lastModifiedBy: object PersonSimple

A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
sensitivityLabels: array sensitivityLabels

The sensitivity labels associated with the condition.

{
    "description":"Sensitivity attributes are related to conditions that could be sensitive to expose, such as mental health details, \nsexually transmitted diseases, substance abuse history, or HIV status. Sensitivity labels help ensure that such \ninformation is handled with extra care, accessed only by authorized personnel, and not inadvertently disclosed.\n",
    "type":"object",
    "properties":{
        "sensitivityLabels":{
            "description":"The sensitivity labels associated with the condition.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CodeValueSimple"
            }
        },
        "lastModifiedBy":{
            "description":"The last personnel member to update the sensitivity label for the condition.",
            "$ref":"#/definitions/PersonSimple"
        }
    }
}

Nested Schema : sensitivityLabels

Type: array

The sensitivity labels associated with the condition.

Show Source

Array of: object CodeValueSimple

A minimal representation of a code value.

{
    "description":"The sensitivity labels associated with the condition.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CodeValueSimple"
    }
}

Nested Schema : commentList

Type: array

The list of comments for the condition in reverse chronological order.

Show Source

Array of: object Comment

Comment details

{
    "description":"The list of comments for the condition in reverse chronological order.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Comment"
    }
}

Nested Schema : entityList

Type: array

The list of the individual acute and chronic entities that make up the condition.

Show Source

Array of: Entity

The model object representing a detailed condition entity.

{
    "description":"The list of the individual acute and chronic entities that make up the condition.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Entity"
    }
}

Nested Schema : ConditionReview

Type: object

A review involves assessing the current status of the condition and determining whether it has improved, worsened, or remained stable. This assessment helps in deciding whether the ongoing treatment is effective or if adjustments are needed. Based on the review, treatment plans may be updated to better address the condition. An update might include changes in medication, therapy, or other interventions.

Show Source

reviewedBy(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 nonpatient person.
reviewedDateTime(required): string(date-time)

The ISO-8601 representation of the date and time the review was performed.

Example: 2016-10-8T01:02:03Z

{
    "description":"A review involves assessing the current status of the condition and determining whether it has improved, worsened, \nor remained stable. This assessment helps in deciding whether the ongoing treatment is effective or if \nadjustments are needed. Based on the review, treatment plans may be updated to better address the condition. \nAn update might include changes in medication, therapy, or other interventions.\n",
    "type":"object",
    "required":[
        "reviewedDateTime",
        "reviewedBy"
    ],
    "properties":{
        "reviewedBy":{
            "description":"The personnel member who performed the review.",
            "$ref":"#/definitions/PersonSimple"
        },
        "reviewedDateTime":{
            "description":"The ISO-8601 representation of the date and time the review was performed.",
            "type":"string",
            "format":"date-time",
            "example":"2016-10-8T01:02:03Z"
        }
    }
}

Nested Schema : Summary

Type: object

The model object representing a summary associated with a condition.

Show Source

isActive(required): boolean
An active condition is current or ongoing, may require active management, and is clinically significant.
- Current or ongoing: The condition is currently affecting the patient as an ongoing issue that requires medical attention, monitoring, or treatment. In contrast, conditions that have been resolved or are in remission might be labeled as inactive or resolved.
- Requires active management: The active status may also imply that the condition requires active management, such as medication, therapy, or other forms of treatment to control its symptoms or progression.
- Clinical significance: An active condition is clinically significant for the patient's current health status and care planning. The condition is relevant to the decisions made by healthcare providers regarding the patient's care and treatment.
isCombined(required): boolean

Conditions that are combined into a single summary might be interrelated, meaning that one condition could influence the development or management of another. For example, diabetes and hypertension are often interrelated and may be managed more effectively when considered together in a patient's care plan.
lastModifiedBy(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 nonpatient person.
recordedDateTime(required): string(date-time)

The ISO-8601 representation of the date and time when the summary was recorded. The date and time are in UTC and can be converted to the local time zone if needed.

Example: 2016-10-8T05:02:03Z
text(required): string

A textual description of the condition's summary. See example for more information.

Example: Hypertension Patient developed Hypertension in 1983. His blood pressure peaked at 160/95. He was placed on HCTZ and it quickly escalated to Lisinopril/HCTZ. In 2005 he added Atenolol. His blood pressures have been under control since. He exercises 20 minutes 3x/week and is on a regular diet.

{
    "description":"The model object representing a summary associated with a condition.",
    "type":"object",
    "required":[
        "isActive",
        "isCombined",
        "lastModifiedBy",
        "recordedDateTime",
        "text"
    ],
    "properties":{
        "text":{
            "description":"A textual description of the condition's summary. See example for more information.",
            "type":"string",
            "example":"<p><b>Hypertension</b></p>\n<p>Patient developed Hypertension in 1983. His blood pressure peaked at 160/95.</p>\n<p>He was placed on HCTZ and it quickly escalated to Lisinopril/HCTZ. In 2005 he added Atenolol.</p>\n<p>His blood pressures have been under control since.</p>\n<p>He exercises 20 minutes 3x/week and is on a regular diet.</p>"
        },
        "lastModifiedBy":{
            "description":"The personnel member who last updated the summary.",
            "$ref":"#/definitions/PersonSimple"
        },
        "recordedDateTime":{
            "description":"The ISO-8601 representation of the date and time when the summary was recorded. The date and time are \nin UTC and can be converted to the local time zone if needed.\n",
            "type":"string",
            "format":"date-time",
            "example":"2016-10-8T05:02:03Z"
        },
        "isActive":{
            "description":"An active condition is current or ongoing, may require active management, and is clinically significant.\n<ul>\n  <li><b>Current or ongoing:</b> The condition is currently affecting the patient as an \n  ongoing issue that requires medical attention, monitoring, or treatment. In contrast, conditions \n  that have been resolved or are in remission might be labeled as <code>inactive</code> or <code>resolved</code>.</li>\n  <li><b>Requires active management:</b> The active status may also imply that the condition requires active \n  management, such as medication, therapy, or other forms of treatment to control its symptoms or progression.</li>\n  <li><b>Clinical significance:</b> An active condition is clinically significant for the patient's current health \n  status and care planning. The condition is relevant to the decisions made by healthcare providers regarding \n  the patient's care and treatment.</li>\n</ul>\n",
            "type":"boolean"
        },
        "isCombined":{
            "description":"Conditions that are combined into a single summary might be interrelated, meaning that one condition \ncould influence the development or management of another. For example, diabetes and hypertension are \noften interrelated and may be managed more effectively when considered together in a patient's care plan.\n",
            "type":"boolean"
        }
    }
}

Nested Schema : Comment

Type: object

Comment details

Show Source

comment: string

The comment text.
commentDateTime: object DateTimeWithZone

A representation of the date and time with the time zone.
commentedBy: object PersonSimple

A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
id: string

The unique identifier of the comment.

{
    "description":"Comment details",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the comment."
        },
        "comment":{
            "type":"string",
            "description":"The comment text."
        },
        "commentDateTime":{
            "$ref":"#/definitions/DateTimeWithZone"
        },
        "commentedBy":{
            "description":"The personnel member who added this comment.",
            "$ref":"#/definitions/PersonSimple"
        }
    }
}

Nested Schema : DateTimeWithZone

Type: object

A representation of the 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 timezone information is associated with this date/time.
ianaTimeZone: string

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

{
    "type":"object",
    "description":"A representation of the date and time with the time zone.",
    "properties":{
        "dateTime":{
            "type":"string",
            "format":"date-time",
            "description":"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>.\nNo timezone information is associated with this date/time.\n"
        },
        "ianaTimeZone":{
            "type":"string",
            "description":"The time zone, provided that the date includes time precision. If <code>dateTime</code> contains time, then this field is required."
        }
    }
}

Nested Schema : Entity

The model object representing a detailed condition entity.

Match All

The model object representing a detailed condition entity.

Show Source

object EntityBase

Contains common properties across entity and conditions.
object Entity-allOf[1]

{
    "description":"The model object representing a detailed condition entity.",
    "allOf":[
        {
            "$ref":"#/definitions/EntityBase"
        },
        {
            "type":"object",
            "required":[
                "id",
                "version",
                "isResolved"
            ],
            "properties":{
                "id":{
                    "description":"The unique identifier of the entity. This value does not change over the life of an entity.",
                    "type":"string",
                    "example":"950109285"
                },
                "version":{
                    "description":"The version of the specific instance that represents the current state of the entity. This value can \nchange as the entity is modified.\n",
                    "type":"string",
                    "example":"950109286"
                },
                "type":{
                    "description":"The type of the entity. Typically populated, but use caution when consuming \nthis enum in case it is not populated or has a value other than those listed.\n",
                    "type":"string",
                    "enum":[
                        "ACUTE",
                        "CHRONIC"
                    ]
                },
                "displayName":{
                    "description":"The display value of the entity.",
                    "type":"string",
                    "example":"Anemia Annotated"
                },
                "beginEffectiveDateTime":{
                    "description":"The date and time when the condition entity became effective.",
                    "type":"string",
                    "format":"date-time",
                    "example":"2016-10-20T01:02:03Z"
                },
                "lastModifiedPersonnelId":{
                    "description":"The ID of the last personnel member to update the condition entity.",
                    "type":"string"
                },
                "lastModifiedDateTime":{
                    "description":"The date and time when the condition entity was last updated.",
                    "type":"string",
                    "format":"date-time",
                    "example":"2016-10-20T01:02:03Z"
                },
                "encounterId":{
                    "description":"The identifier of the encounter (visit) that this entity is associated with. This identifier is only \napplicable to an acute entity.\n",
                    "type":"string",
                    "example":"1654324"
                },
                "acuteDate":{
                    "description":"Represents only the acute diagnosis date associated with the condition and is only applicable to an acute \nentity. This date does not include any time information.\n",
                    "type":"string",
                    "format":"date",
                    "example":"2016-10-20"
                },
                "isResolved":{
                    "description":"If true, the problem is resolved or no longer relevant",
                    "type":"boolean"
                }
            }
        }
    ]
}

Nested Schema : Entity-allOf[1]

Type: object

Show Source

acuteDate: string(date)

Represents only the acute diagnosis date associated with the condition and is only applicable to an acute entity. This date does not include any time information.

Example: 2016-10-20
beginEffectiveDateTime: string(date-time)

The date and time when the condition entity became effective.

Example: 2016-10-20T01:02:03Z
displayName: string

The display value of the entity.

Example: Anemia Annotated
encounterId: string

The identifier of the encounter (visit) that this entity is associated with. This identifier is only applicable to an acute entity.

Example: 1654324
id(required): string

The unique identifier of the entity. This value does not change over the life of an entity.

Example: 950109285
isResolved(required): boolean

If true, the problem is resolved or no longer relevant
lastModifiedDateTime: string(date-time)

The date and time when the condition entity was last updated.

Example: 2016-10-20T01:02:03Z
lastModifiedPersonnelId: string

The ID of the last personnel member to update the condition entity.
type: string

Allowed Values: [ "ACUTE", "CHRONIC" ]

The type of the entity. Typically populated, but use caution when consuming this enum in case it is not populated or has a value other than those listed.
version(required): string

The version of the specific instance that represents the current state of the entity. This value can change as the entity is modified.

Example: 950109286

{
    "type":"object",
    "required":[
        "id",
        "version",
        "isResolved"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier of the entity. This value does not change over the life of an entity.",
            "type":"string",
            "example":"950109285"
        },
        "version":{
            "description":"The version of the specific instance that represents the current state of the entity. This value can \nchange as the entity is modified.\n",
            "type":"string",
            "example":"950109286"
        },
        "type":{
            "description":"The type of the entity. Typically populated, but use caution when consuming \nthis enum in case it is not populated or has a value other than those listed.\n",
            "type":"string",
            "enum":[
                "ACUTE",
                "CHRONIC"
            ]
        },
        "displayName":{
            "description":"The display value of the entity.",
            "type":"string",
            "example":"Anemia Annotated"
        },
        "beginEffectiveDateTime":{
            "description":"The date and time when the condition entity became effective.",
            "type":"string",
            "format":"date-time",
            "example":"2016-10-20T01:02:03Z"
        },
        "lastModifiedPersonnelId":{
            "description":"The ID of the last personnel member to update the condition entity.",
            "type":"string"
        },
        "lastModifiedDateTime":{
            "description":"The date and time when the condition entity was last updated.",
            "type":"string",
            "format":"date-time",
            "example":"2016-10-20T01:02:03Z"
        },
        "encounterId":{
            "description":"The identifier of the encounter (visit) that this entity is associated with. This identifier is only \napplicable to an acute entity.\n",
            "type":"string",
            "example":"1654324"
        },
        "acuteDate":{
            "description":"Represents only the acute diagnosis date associated with the condition and is only applicable to an acute \nentity. This date does not include any time information.\n",
            "type":"string",
            "format":"date",
            "example":"2016-10-20"
        },
        "isResolved":{
            "description":"If true, the problem is resolved or no longer relevant",
            "type":"boolean"
        }
    }
}

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