Jump to

• Request
• Response

Get an allergy by allergy ID

get

/20240101/allergies/{allergyId}

Retrieves an allergy for the given patient ID and allergy ID.

Note: If no allergy is found with the given allergy ID and patient ID, a 404 Not Found response is returned.

Request

Path Parameters

• allergyId(required): string
  The unique identifier of the allergy.

Query Parameters

• patientId(required): string
  Identifier of patient 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 Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

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.

Body ()

Root Schema : Allergy

Type: object

The allergy details.

Show Source

• cancelReason: object CodeValueSimple
  A minimal representation of a code value.
• category: object CodeValueSimple
  A minimal representation of a code value.
• createdBy(required): object PersonSimple

  A simple representation of the individual person that was retrieved.

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

• createdDateTime(required): string(date-time)
  The date and time that the allergy was created in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• criticality: object CodeValueSimple
  A minimal representation of a code value.
• encounterId: string

  The unique identifier of the encounter that the allergy was added to.

  If no encounter is associated with the allergy, then this value is omitted.

• id(required): string
  The unique identifier of the allergy.
• infoSource: object CodeValueSimple
  A minimal representation of a code value.
• isPharmacyVerified: boolean
  Default Value: false

  The indicator that denotes if the allergy is verified by a pharmacy.
• 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 non-patient person.

• lastModifiedDateTime(required): string(date-time)
  The date and time that the allergy was last modified in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• notes: array notes
  Unique Items Required: true

  The list of notes added to this allergy. This value can be empty.
• onBehalfOf: object PersonSimple

  A simple representation of the individual person that was retrieved.

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

• onset: object AllergyFuzzyDateTime

  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 in conjunction with the provided date and time 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 FuzzyDateTimeUnit or FuzzyDateTimePrecision values are supported by that API.

• organizationId: string
  The unique identifier of the organization.
• patient(required): object PersonSimple

  A simple representation of the individual person that was retrieved.

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

• permissions: array permissions
  Unique Items Required: true

  The set of allergy related permissions granted to the requesting user.

  MODIFY_ALLERGY indicates that the user has permission to modify the existing allergy.

• reactions: array reactions
  Unique Items Required: true

  A list of reactions associated with this allergy. This list can be empty.
• reactionType: object CodeValueSimple
  A minimal representation of a code value.
• reviewInfo: object ReviewInfo
  The information around who and when the data was reviewed.
• status: object AllergyStatus
  The allergy status details.
• substance(required): object NomenclatureOrFreetextValue
  The nomenclature or free text value of the data.
• version(required): string
  The unique identifier of this version of the allergy.

{
    "description":"The allergy details.",
    "type":"object",
    "required":[
        "id",
        "version",
        "createdDateTime",
        "createdBy",
        "lastModifiedDateTime",
        "lastModifiedBy",
        "patient",
        "substance"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the allergy."
        },
        "version":{
            "type":"string",
            "description":"The unique identifier of this version of the allergy."
        },
        "createdDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that the allergy was created in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        },
        "createdBy":{
            "description":"The original personnel member who created this allergy.",
            "$ref":"#/definitions/PersonSimple"
        },
        "lastModifiedDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that the allergy was last modified in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        },
        "lastModifiedBy":{
            "description":"The personnel who last updated this allergy.",
            "$ref":"#/definitions/PersonSimple"
        },
        "patient":{
            "description":"The patient details of the allergy.",
            "$ref":"#/definitions/PersonSimple"
        },
        "substance":{
            "description":"The substance causing the allergy.",
            "$ref":"#/definitions/NomenclatureOrFreetextValue"
        },
        "reviewInfo":{
            "description":"The details of the allergy review.",
            "$ref":"#/definitions/ReviewInfo"
        },
        "notes":{
            "type":"array",
            "description":"The list of notes added to this allergy. This value can be empty.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Annotation"
            }
        },
        "cancelReason":{
            "description":"The information about the reason the allergy is canceled.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "encounterId":{
            "type":"string",
            "description":"<p>The unique identifier of the encounter that the allergy was added to.</p>\n<p>If no encounter is associated with the allergy, then this value is omitted.</p>\n"
        },
        "infoSource":{
            "example":"PATIENT, FAMILY, SELF",
            "description":"The source who provided the information for this allergy.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "onset":{
            "description":"The information about when the onset occurred.",
            "$ref":"#/definitions/AllergyFuzzyDateTime"
        },
        "organizationId":{
            "type":"string",
            "description":"The unique identifier of the organization."
        },
        "reactions":{
            "type":"array",
            "description":"A list of reactions associated with this allergy. This list can be empty.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AllergyReaction"
            }
        },
        "onBehalfOf":{
            "description":"The allergy created on behalf of the personnel member.",
            "$ref":"#/definitions/PersonSimple"
        },
        "criticality":{
            "example":"HIGH, MEDIUM, LOW",
            "description":"The criticality level of the allergy.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "status":{
            "example":"ACTIVE, PROPOSED",
            "description":"The status of the allergy.",
            "$ref":"#/definitions/AllergyStatus"
        },
        "category":{
            "example":"ANIMAL, DRUG, FOOD, MEDICATION",
            "description":"The category of this allergy's substance.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "reactionType":{
            "example":"ALLERGY, INTOLERANCE, SENSITIVITY",
            "description":"The information about the reaction type of the allergy.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "permissions":{
            "type":"array",
            "description":"<p>The set of allergy related permissions granted to the requesting user.</p>\n<p><code>MODIFY_ALLERGY</code> indicates that the user has permission to modify the existing allergy.</p>",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "MODIFY_ALLERGY"
                ]
            }
        },
        "isPharmacyVerified":{
            "description":"The indicator that denotes if the allergy is verified by a pharmacy.",
            "type":"boolean",
            "default":false
        }
    }
}

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 non-patient person.

Show Source

• id(required): string
  The unique identifier for the individual.
• name: object PersonNameSummary
  A summary of the first, last, and full name for a person. The person could be a personnel member, patient, or non-patient person.

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

Nested Schema : notes

Type: array

Unique Items Required: true

The list of notes added to this allergy. This value can be empty.

Show Source

• Array of: object Annotation
  A text note that also contains information about who made the statement and when.

{
    "type":"array",
    "description":"The list of notes added to this allergy. This value can be empty.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Annotation"
    }
}

Nested Schema : AllergyFuzzyDateTime

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 in conjunction with the provided date and time 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 FuzzyDateTimeUnit or FuzzyDateTimePrecision values are supported by that API.

Show Source

• dateTime: object DateTimeStringWithZone
  Representation of the date and time with time zone.
• precision: object AllergyFuzzyDateTimePrecision
  A code value representation of the precision associated with a date.
• unit: object AllergyFuzzyDateTimeUnit
  A display and enumerated meaning structure representing the date and time unit like DAY, WEEK, MONTH, and YEAR.

{
    "type":"object",
    "properties":{
        "unit":{
            "$ref":"#/definitions/AllergyFuzzyDateTimeUnit"
        },
        "precision":{
            "$ref":"#/definitions/AllergyFuzzyDateTimePrecision"
        },
        "dateTime":{
            "$ref":"#/definitions/DateTimeStringWithZone",
            "description":"<p>The datetime and timezone when the event occurred that is formatted based on the onset precision flag.</p>\n<ul>\n<li>If the precision flag is TIME or no precision flag is available, the value is in YYYY-MM-DDTHH:MM:SS:SSSZ format.</li>\n<li>If the precision flag is DAY or WEEK the value is in YYYY-MM-DD format in the onset timezone.</li>\n<li>If the precision flag is MONTH the value is in YYYY-MM format in the onset timezone.</li>\n<li>If the precision flag is YEAR the value is in YYYY format in the onset timezone.</li>\n</ul>\n",
            "example":"precision flag: TIME or if there is no precision flag ----> 2018-06-16T21:31:35.457Z\nprecision flag: DAY or WEEK ----> 2018-06-16\nprecision flag: MONTH ----> 2018-06\nprecision flag: YEAR ----> 2018\n"
        }
    },
    "description":"<p>The model object for a fuzzy date associated with a clinical concept with a corresponding precision and unit applied to it.</p>\n<p>The precision and unit are used in conjunction with the provided date and time to communicate a possibly imprecise date, for example,\nAge 28 or Sometime After 2020-04. Note that the <code>/referenceData</code> for a given API should be queried to confirm exactly which\n<code>FuzzyDateTimeUnit</code> or <code>FuzzyDateTimePrecision</code> values are supported by that API.</p>\n"
}

Nested Schema : permissions

Type: array

Unique Items Required: true

The set of allergy related permissions granted to the requesting user.

MODIFY_ALLERGY indicates that the user has permission to modify the existing allergy.

Show Source

• Array of: string
  Allowed Values: [ "MODIFY_ALLERGY" ]

{
    "type":"array",
    "description":"<p>The set of allergy related permissions granted to the requesting user.</p>\n<p><code>MODIFY_ALLERGY</code> indicates that the user has permission to modify the existing allergy.</p>",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "MODIFY_ALLERGY"
        ]
    }
}

Nested Schema : reactions

Type: array

Unique Items Required: true

A list of reactions associated with this allergy. This list can be empty.

Show Source

• Array of: object AllergyReaction
  The allergy reaction details.

{
    "type":"array",
    "description":"A list of reactions associated with this allergy. This list can be empty.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AllergyReaction"
    }
}

Nested Schema : ReviewInfo

Type: object

The information around who and when the data was reviewed.

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 non-patient person.

• reviewedDateTime(required): object DateTimeWithZone
  Representation of date and time with the time zone.

{
    "description":"The information around who and when the data was reviewed.",
    "type":"object",
    "required":[
        "reviewedDateTime",
        "reviewedBy"
    ],
    "properties":{
        "reviewedDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time and time zone the review occurred in."
        },
        "reviewedBy":{
            "description":"The details of the personnel member who reviewed this data.",
            "$ref":"#/definitions/PersonSimple"
        }
    }
}

Nested Schema : AllergyStatus

Type: object

The allergy status details.

Show Source

• lastModifiedDateTime: string(date-time)
  The date and time when the status was last updated in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• value: object CodeValueSimple
  A minimal representation of a code value.

{
    "description":"The allergy status details.",
    "type":"object",
    "properties":{
        "value":{
            "description":"The status of the allergy.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "lastModifiedDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time when the status was last updated in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        }
    }
}

Nested Schema : NomenclatureOrFreetextValue

Type: object

The nomenclature or free text value of the data.

Show Source

• freeText: string
  The free text display of the data. This display is returned only if the type is FREE_TEXT.
• nomenclature: object NomenclatureSimple
  The model object for a nomenclature.
• type(required): string
  Allowed Values: [ "NOMENCLATURE", "FREE_TEXT" ]

  The type of value the data is captured as.

{
    "description":"The nomenclature or free text value of the data.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "nomenclature":{
            "description":"The nomenclature details of the data. The details are returned only if the type is <code>NOMENCLATURE</code>.",
            "$ref":"#/definitions/NomenclatureSimple"
        },
        "freeText":{
            "type":"string",
            "description":"The free text display of the data. This display is returned only if the type is <code>FREE_TEXT</code>."
        },
        "type":{
            "type":"string",
            "description":"The type of value the data is captured as.",
            "enum":[
                "NOMENCLATURE",
                "FREE_TEXT"
            ]
        }
    }
}

Nested Schema : PersonNameSummary

Type: object

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

Show Source

• firstName: string
  The person's first given name.
• fullName: string
  The fully formatted name.
• lastName: string
  The person's family last name.

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

Nested Schema : Annotation

Type: object

A text note that also contains information about who made the statement and when.

Show Source

• author: object PersonSimple

  A simple representation of the individual person that was retrieved.

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

• dateTime: string(date-time)
  The date and time represented in the format (YYYY-MM-DDTHH:MM:SS:SSSZ) without the UTC offset as defined by RFC 3339. No time zone information is associated with this date and time.
• text: string
  The annotation text

{
    "description":"A text note that also contains information about who made the statement and when.",
    "type":"object",
    "properties":{
        "author":{
            "$ref":"#/definitions/PersonSimple"
        },
        "dateTime":{
            "type":"string",
            "description":"The date and time represented in the format (YYYY-MM-DDTHH:MM:SS:SSSZ) without the UTC offset as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\nNo time zone information is associated with this date and time.\n",
            "format":"date-time"
        },
        "text":{
            "type":"string",
            "description":"The annotation text"
        }
    }
}

Nested Schema : DateTimeStringWithZone

Type: object

Representation of the date and time with time zone.

Show Source

• dateTime: string

  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 and time.
• ianaTimeZone: string
  The time zone, provided that the date includes time precision. If dateTime contains time, then this value is required.

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

Nested Schema : AllergyFuzzyDateTimePrecision

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
• id(required): string
  The ID of the code value.

  Example: 1643574645
• meaning: string
  Allowed Values: [ "ABOUT", "AFTER", "AGE", "BEFORE", "UNKNOWN" ]

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

{
    "type":"object",
    "required":[
        "id",
        "display"
    ],
    "properties":{
        "id":{
            "description":"The ID of the code value.",
            "example":"1643574645",
            "type":"string"
        },
        "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 caution should be taken 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 : AllergyFuzzyDateTimeUnit

Type: object

A display and enumerated meaning structure representing the date and time unit like DAY, WEEK, MONTH, and YEAR.

Show Source

• display(required): string
  The display for the date and time unit.

  Example: Date
• meaning: string
  Allowed Values: [ "TIME", "DAY", "WEEK", "MONTH", "YEAR" ]

  The unit associated with the fuzzy date.

  Example: DAY

{
    "type":"object",
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "example":"Date",
            "description":"The display for the date and time unit."
        },
        "meaning":{
            "type":"string",
            "example":"DAY",
            "description":"The unit associated with the fuzzy date.",
            "enum":[
                "TIME",
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR"
            ]
        }
    },
    "description":"A display and enumerated meaning structure representing the date and time unit like <code>DAY</code>, <code>WEEK</code>, <code>MONTH</code>, and <code>YEAR</code>."
}

Nested Schema : AllergyReaction

Type: object

The allergy reaction details.

Show Source

• id: string
  The unique identifier of the reaction.
• isActive: boolean
  Default Value: false

  The status of the reaction. Returns true if the reaction is active. The default is false.
• lastModifiedDateTime: string(date-time)
  The date and time that the reaction was updated in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• severity: object CodeValueSimple
  A minimal representation of a code value.
• symptom(required): object NomenclatureOrFreetextValue
  The nomenclature or free text value of the data.

{
    "description":"The allergy reaction details.",
    "type":"object",
    "required":[
        "symptom"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the reaction."
        },
        "severity":{
            "description":"The severity of the reaction.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "isActive":{
            "type":"boolean",
            "description":"The status of the reaction. Returns true if the reaction is active. The default is false.",
            "default":false
        },
        "symptom":{
            "description":"The information about the symptoms of the reaction.",
            "$ref":"#/definitions/NomenclatureOrFreetextValue"
        },
        "lastModifiedDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that the reaction was updated in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        }
    }
}

Nested Schema : DateTimeWithZone

Type: object

Representation of date and time with the time zone.

Show Source

• dateTime: string(date-time)

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

  No time zone information is associated with this date and time.

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

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

Nested Schema : 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."
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

403 Response

NotAuthorized

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any errors from the resulting service call.
• message(required): string
  A human-readable error message.

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

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers which caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers

  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

  For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

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

Nested Schema : headers

Type: array

A list of the request headers which caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error.

For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON pointer must point to a value in the request document that exists; if it does not, ignore the pointer.

Show Source

• Array of: string

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

Back to Top