# Create FHIR r4 claim response

Endpoint: POST /site/{siteId}/fhir/claim-response
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `siteId` (string, required)
    Site identifier

## Request fields (application/json):

  - `resourceType` (any, required)
    This is a ClaimResponse resource
    Enum: "ClaimResponse"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    A unique identifier assigned to this claim response.
    Example: [{"system":"http://www.BenefitsInc.com/fhir/remittance","value":"R3500"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `type` (object, required)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `type.coding` (array)
    A reference to a code defined by a terminology system.

  - `type.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `type._text` (object)
    An extension object type #Element.

  - `subType` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `use` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_use` (object)
    Base definition for all elements in a resource.

  - `patient` (object, required)
    A reference from one resource to another.

  - `patient.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._reference` (object)
    An extension object type #Element.

  - `patient.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `patient._type` (object)
    An extension object type #Element.

  - `patient.identifier` (object)
    An extension object type #Identifier.

  - `patient.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._display` (object)
    An extension object type #Element.

  - `created` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_created` (object)
    Base definition for all elements in a resource.

  - `insurer` (object, required)
    A reference from one resource to another.

  - `requestor` (object)
    A reference from one resource to another.

  - `request` (object)
    A reference from one resource to another.

  - `outcome` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_outcome` (object)
    Base definition for all elements in a resource.

  - `disposition` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_disposition` (object)
    Base definition for all elements in a resource.

  - `preAuthRef` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_preAuthRef` (object)
    Base definition for all elements in a resource.

  - `preAuthPeriod` (object)
    A time period defined by a start and end date and optionally time.

  - `preAuthPeriod.start` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `preAuthPeriod._start` (object)
    An extension object type #Element.

  - `preAuthPeriod.end` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `preAuthPeriod._end` (object)
    An extension object type #Element.

  - `payeeType` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `item` (array)
    A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
    Example: [{"itemSequence":1,"adjudication":[{"category":{"coding":[{"code":"eligible"}]},"amount":{"value":135.57,"currency":"USD"}},{"category":{"coding":[{"code":"copay"}]},"amount":{"value":10,"currency":"USD"}},{"category":{"coding":[{"code":"eligpercent"}]},"value":80},{"category":{"coding":[{"code":"benefit"}]},"reason":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/adjudication-reason","code":"ar002","display":"Plan Limit Reached"}]},"amount":{"value":90.47,"currency":"USD"}}]}]

  - `item.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `item.itemSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `item._itemSequence` (object)
    An extension object type #Element.

  - `item.noteNumber` (array)
    The numbers associated with notes below which apply to the adjudication of this item.
    Example: [1]

  - `item._noteNumber` (array)
    Extensions for noteNumber

  - `item.adjudication` (array, required)
    If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

  - `item.detail` (array)
    A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

  - `addItem` (array)
    The first-tier service adjudications for payor added product or service lines.

  - `addItem.itemSequence` (array)
    Claim items which this service line is intended to replace.
    Example: [1]

  - `addItem._itemSequence` (array)
    Extensions for itemSequence

  - `addItem.detailSequence` (array)
    The sequence number of the details within the claim item which this line is intended to replace.
    Example: [1]

  - `addItem._detailSequence` (array)
    Extensions for detailSequence

  - `addItem.subdetailSequence` (array)
    The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
    Example: [1]

  - `addItem._subdetailSequence` (array)
    Extensions for subdetailSequence

  - `addItem.provider` (array)
    The providers who are authorized for the services rendered to the patient.

  - `addItem.productOrService` (object, required)
    An extension object type #CodeableConcept.

  - `addItem.modifier` (array)
    Item typification or modifiers codes to convey additional context for the product or service.

  - `addItem.programCode` (array)
    Identifies the program under which this may be recovered.

  - `addItem.servicedDate` (string)
    The date or dates when the service or product was supplied, performed or completed.
    Example: "example-string"

  - `addItem._servicedDate` (object)
    An extension object type #Element.

  - `addItem.servicedPeriod` (object)
    An extension object type #Period.

  - `addItem.locationCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `addItem.locationAddress` (object)
    An extension object type #Address.

  - `addItem.locationReference` (object)
    An extension object type #Reference.

  - `addItem.quantity` (object)
    An extension object type #Quantity.

  - `addItem.unitPrice` (object)
    An extension object type #Money.

  - `addItem.factor` (number)
    An extension object type #decimal.
    Example: 1.23

  - `addItem._factor` (object)
    An extension object type #Element.

  - `addItem.net` (object)
    An extension object type #Money.

  - `addItem.bodySite` (object)
    An extension object type #CodeableConcept.

  - `addItem.subSite` (array)
    A region or surface of the bodySite, e.g. limb region or tooth surface(s).

  - `addItem.adjudication` (array, required)
    The adjudication results.

  - `addItem.detail` (array)
    The second-tier service adjudications for payor added services.

  - `adjudication` (array)
    The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

  - `adjudication.category` (object, required)
    An extension object type #CodeableConcept.

  - `adjudication.reason` (object)
    An extension object type #CodeableConcept.

  - `adjudication.amount` (object)
    An extension object type #Money.

  - `adjudication.value` (number)
    An extension object type #decimal.
    Example: 1.23

  - `total` (array)
    Categorized monetary totals for the adjudication.
    Example: [{"category":{"coding":[{"code":"submitted"}]},"amount":{"value":135.57,"currency":"USD"}},{"category":{"coding":[{"code":"benefit"}]},"amount":{"value":90.47,"currency":"USD"}}]

  - `payment` (object)
    This resource provides the adjudication details from the processing of a Claim resource.

  - `payment.adjustment` (object)
    An extension object type #Money.

  - `payment.adjustmentReason` (object)
    An extension object type #CodeableConcept.

  - `payment.date` (string)
    An extension object type #date.
    Example: "2024-01-01"

  - `payment._date` (object)
    An extension object type #Element.

  - `fundsReserve` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `formCode` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `form` (object)
    For referring to data content defined in other formats.

  - `form.contentType` (string)
    An extension object type #code.
    Example: "sample-code"

  - `form._contentType` (object)
    An extension object type #Element.

  - `form.language` (string)
    An extension object type #code.
    Example: "sample-code"

  - `form._language` (object)
    An extension object type #Element.

  - `form.data` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `form._data` (object)
    An extension object type #Element.

  - `form.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `form.size` (integer)
    An extension object type #unsignedInt.

  - `form._size` (object)
    An extension object type #Element.

  - `form.hash` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `form._hash` (object)
    An extension object type #Element.

  - `form.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `form._title` (object)
    An extension object type #Element.

  - `form.creation` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `form._creation` (object)
    An extension object type #Element.

  - `processNote` (array)
    A note that describes or explains adjudication results in a human readable form.

  - `processNote.number` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `processNote._number` (object)
    An extension object type #Element.

  - `processNote.type` (any)
    The business purpose of the note text.
    Enum: "display", "print", "printoper"

  - `processNote.language` (object)
    An extension object type #CodeableConcept.

  - `communicationRequest` (array)
    Request for additional supporting or authorizing information.

  - `insurance` (array)
    Financial instruments for reimbursement for the health care products and services specified on the claim.

  - `insurance.sequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `insurance._sequence` (object)
    An extension object type #Element.

  - `insurance.focal` (boolean)
    An extension object type #boolean.
    Example: true

  - `insurance._focal` (object)
    An extension object type #Element.

  - `insurance.coverage` (object, required)
    An extension object type #Reference.

  - `insurance.businessArrangement` (string)
    An extension object type #string.
    Example: "example-string"

  - `insurance._businessArrangement` (object)
    An extension object type #Element.

  - `insurance.claimResponse` (object)
    An extension object type #Reference.

  - `error` (array)
    Errors encountered during the processing of the adjudication.

  - `error.detailSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `error._detailSequence` (object)
    An extension object type #Element.

  - `error.subDetailSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `error._subDetailSequence` (object)
    An extension object type #Element.

  - `error.code` (object, required)
    An extension object type #CodeableConcept.

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a ClaimResponse resource
    Enum: "ClaimResponse"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    A unique identifier assigned to this claim response.
    Example: [{"system":"http://www.BenefitsInc.com/fhir/remittance","value":"R3500"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `type` (object, required)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `type.coding` (array)
    A reference to a code defined by a terminology system.

  - `type.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `type._text` (object)
    An extension object type #Element.

  - `subType` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `use` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_use` (object)
    Base definition for all elements in a resource.

  - `patient` (object, required)
    A reference from one resource to another.

  - `patient.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._reference` (object)
    An extension object type #Element.

  - `patient.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `patient._type` (object)
    An extension object type #Element.

  - `patient.identifier` (object)
    An extension object type #Identifier.

  - `patient.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._display` (object)
    An extension object type #Element.

  - `created` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_created` (object)
    Base definition for all elements in a resource.

  - `insurer` (object, required)
    A reference from one resource to another.

  - `requestor` (object)
    A reference from one resource to another.

  - `request` (object)
    A reference from one resource to another.

  - `outcome` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_outcome` (object)
    Base definition for all elements in a resource.

  - `disposition` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_disposition` (object)
    Base definition for all elements in a resource.

  - `preAuthRef` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_preAuthRef` (object)
    Base definition for all elements in a resource.

  - `preAuthPeriod` (object)
    A time period defined by a start and end date and optionally time.

  - `preAuthPeriod.start` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `preAuthPeriod._start` (object)
    An extension object type #Element.

  - `preAuthPeriod.end` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `preAuthPeriod._end` (object)
    An extension object type #Element.

  - `payeeType` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `item` (array)
    A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
    Example: [{"itemSequence":1,"adjudication":[{"category":{"coding":[{"code":"eligible"}]},"amount":{"value":135.57,"currency":"USD"}},{"category":{"coding":[{"code":"copay"}]},"amount":{"value":10,"currency":"USD"}},{"category":{"coding":[{"code":"eligpercent"}]},"value":80},{"category":{"coding":[{"code":"benefit"}]},"reason":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/adjudication-reason","code":"ar002","display":"Plan Limit Reached"}]},"amount":{"value":90.47,"currency":"USD"}}]}]

  - `item.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `item.itemSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `item._itemSequence` (object)
    An extension object type #Element.

  - `item.noteNumber` (array)
    The numbers associated with notes below which apply to the adjudication of this item.
    Example: [1]

  - `item._noteNumber` (array)
    Extensions for noteNumber

  - `item.adjudication` (array, required)
    If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

  - `item.detail` (array)
    A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

  - `addItem` (array)
    The first-tier service adjudications for payor added product or service lines.

  - `addItem.itemSequence` (array)
    Claim items which this service line is intended to replace.
    Example: [1]

  - `addItem._itemSequence` (array)
    Extensions for itemSequence

  - `addItem.detailSequence` (array)
    The sequence number of the details within the claim item which this line is intended to replace.
    Example: [1]

  - `addItem._detailSequence` (array)
    Extensions for detailSequence

  - `addItem.subdetailSequence` (array)
    The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
    Example: [1]

  - `addItem._subdetailSequence` (array)
    Extensions for subdetailSequence

  - `addItem.provider` (array)
    The providers who are authorized for the services rendered to the patient.

  - `addItem.productOrService` (object, required)
    An extension object type #CodeableConcept.

  - `addItem.modifier` (array)
    Item typification or modifiers codes to convey additional context for the product or service.

  - `addItem.programCode` (array)
    Identifies the program under which this may be recovered.

  - `addItem.servicedDate` (string)
    The date or dates when the service or product was supplied, performed or completed.
    Example: "example-string"

  - `addItem._servicedDate` (object)
    An extension object type #Element.

  - `addItem.servicedPeriod` (object)
    An extension object type #Period.

  - `addItem.locationCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `addItem.locationAddress` (object)
    An extension object type #Address.

  - `addItem.locationReference` (object)
    An extension object type #Reference.

  - `addItem.quantity` (object)
    An extension object type #Quantity.

  - `addItem.unitPrice` (object)
    An extension object type #Money.

  - `addItem.factor` (number)
    An extension object type #decimal.
    Example: 1.23

  - `addItem._factor` (object)
    An extension object type #Element.

  - `addItem.net` (object)
    An extension object type #Money.

  - `addItem.bodySite` (object)
    An extension object type #CodeableConcept.

  - `addItem.subSite` (array)
    A region or surface of the bodySite, e.g. limb region or tooth surface(s).

  - `addItem.adjudication` (array, required)
    The adjudication results.

  - `addItem.detail` (array)
    The second-tier service adjudications for payor added services.

  - `adjudication` (array)
    The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

  - `adjudication.category` (object, required)
    An extension object type #CodeableConcept.

  - `adjudication.reason` (object)
    An extension object type #CodeableConcept.

  - `adjudication.amount` (object)
    An extension object type #Money.

  - `adjudication.value` (number)
    An extension object type #decimal.
    Example: 1.23

  - `total` (array)
    Categorized monetary totals for the adjudication.
    Example: [{"category":{"coding":[{"code":"submitted"}]},"amount":{"value":135.57,"currency":"USD"}},{"category":{"coding":[{"code":"benefit"}]},"amount":{"value":90.47,"currency":"USD"}}]

  - `payment` (object)
    This resource provides the adjudication details from the processing of a Claim resource.

  - `payment.adjustment` (object)
    An extension object type #Money.

  - `payment.adjustmentReason` (object)
    An extension object type #CodeableConcept.

  - `payment.date` (string)
    An extension object type #date.
    Example: "2024-01-01"

  - `payment._date` (object)
    An extension object type #Element.

  - `fundsReserve` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `formCode` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `form` (object)
    For referring to data content defined in other formats.

  - `form.contentType` (string)
    An extension object type #code.
    Example: "sample-code"

  - `form._contentType` (object)
    An extension object type #Element.

  - `form.language` (string)
    An extension object type #code.
    Example: "sample-code"

  - `form._language` (object)
    An extension object type #Element.

  - `form.data` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `form._data` (object)
    An extension object type #Element.

  - `form.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `form.size` (integer)
    An extension object type #unsignedInt.

  - `form._size` (object)
    An extension object type #Element.

  - `form.hash` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `form._hash` (object)
    An extension object type #Element.

  - `form.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `form._title` (object)
    An extension object type #Element.

  - `form.creation` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `form._creation` (object)
    An extension object type #Element.

  - `processNote` (array)
    A note that describes or explains adjudication results in a human readable form.

  - `processNote.number` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `processNote._number` (object)
    An extension object type #Element.

  - `processNote.type` (any)
    The business purpose of the note text.
    Enum: "display", "print", "printoper"

  - `processNote.language` (object)
    An extension object type #CodeableConcept.

  - `communicationRequest` (array)
    Request for additional supporting or authorizing information.

  - `insurance` (array)
    Financial instruments for reimbursement for the health care products and services specified on the claim.

  - `insurance.sequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `insurance._sequence` (object)
    An extension object type #Element.

  - `insurance.focal` (boolean)
    An extension object type #boolean.
    Example: true

  - `insurance._focal` (object)
    An extension object type #Element.

  - `insurance.coverage` (object, required)
    An extension object type #Reference.

  - `insurance.businessArrangement` (string)
    An extension object type #string.
    Example: "example-string"

  - `insurance._businessArrangement` (object)
    An extension object type #Element.

  - `insurance.claimResponse` (object)
    An extension object type #Reference.

  - `error` (array)
    Errors encountered during the processing of the adjudication.

  - `error.detailSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `error._detailSequence` (object)
    An extension object type #Element.

  - `error.subDetailSequence` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `error._subDetailSequence` (object)
    An extension object type #Element.

  - `error.code` (object, required)
    An extension object type #CodeableConcept.

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields