$submit-attachment

Submit Attachment Operation

activeDa Vinci CDex2.1.0operation9 inputs

Providers use this operation to submit *solicited* and *unsolicited* attachments or additional information for claims or prior authorization. The $submit-attachment operation accepts the clinical/administrative attachments and the information required to associate them with the claim or prior authorization and returns an HTTP response. For *unsolicited* attachments, the Provider invokes this operation *before, concurrently, or after* the claim or pre-authorization transaction. For *solicited* attachments, the Provider invokes it when responding to a Payer request for attachments or additional information. Any HTTP endpoint can use $submit-attachment, not just FHIR RESTful server endpoints. Implementers of CDex's *Unsolicited* Attachments SHOULD support the Endpoint Discovery Strategy defined in the Da Vinci HRex specification to allow discovery of the endpoint for this operation. For *Solicited Attachments*, the $submit-attachment endpoint is supplied in the CDex Task Attachment Request Profile

The input parameters are: 1. One or more attachments as FHIR Resources - Optionally, one or more unique line item numbers associated with the attachment - Optionally, the attachment code used to request the information 1. Data elements for the association to the claim/prior authorization - A unique identifier that ties the attachment(s) back to the claim or prior authorization. (referred to as the "re-association tracking control numbers") - What are the attachments for: - Claims - Prior Authorizations - Optionally, a unique payer identifier - A unique organization/location identifier (e.g., Type 2 NPI) or unique provider identifier (e.g., Type 1 NPI) - A unique Patient member identifier - A Date of Service - A Flag indicating whether the operation is the last attachment submission for the claim or prior authorization.

There are no output parameters.

Metadata

hl7.org/fhir

Canonical URL: http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment
Code: $submit-attachment
Kind: operation
Affects State: No
Publisher: HL7 International / Payer/Provider Information Exchange Work Group

Invocation Context

Can be invoked at:

System Level

Target Resources:

Implementation Notes

The following rules apply when using `$submit-attachment`: * The operation's endpoint **SHALL** only accept `POST` transactions - any other HTTP method **SHALL** result in an HTTP error. * A ProviderId parameter, OrganizationId parameter, or both **SHALL** be present. * The ServiceDate parameter **SHALL** be present and precise to the day if the attachment is for a claim. It is optional if the attachment is for prior authorization. * The `Attachment.LineItem` and `Attachment.Code` parameters are associated with the attachments in `Attachment.Content`. If `Attachment.LineItem` is absent, the attachment is associated with the entire claim or prior authorization. * For the `Attachment.Content` parameter, Servers **SHALL** support [DocumentReference](http://hl7.org/fhir/documentreference.html) resource type and **SHOULD** support other types. If Servers support requesting attachments with [Questionnaire](http://hl7.org/fhir/questionnaire.html), then the [SDC Questionnaire Response Profile](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse) **SHALL** be supported and the [SDC Adaptive Questionnaire Response Profile](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt) **SHOULD** be supported. * The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using `DocumentReference.attachment.url` or the content as inline base64 encoded data using `DocumentReference.attachment.data`. The server system is not required to support both an address and inline base64 encoded data, but **SHALL** support at least one of these elements. * These capabilities **SHOULD** be discoverable and documented by the server (for example, in the CapabilityStatement for FHIR Servers). * When the `Final` parameter is omitted, the default meaning is Final="true" - the operation is the last attachment submission (solicited or unsolicited) for the claim or prior authorization. * When processing the operation, a server may return one of several status codes: * **200 OK**: Indicates that the server has accepted the clinical attachments. * If the attachments can not be associated with an *existing* claim or member, the server **SHOULD** return an [OperationOutcome](http://hl7.org/fhir/operationoutcome.html) to inform the Data Source that they are being held for a subsequent association with a future claim or prior authorization. * **4xx**: Indicates some error in the submission. The client **SHOULD** interpret a 4xx response to indicate that there is no point in resubmitting the unaltered operation, * **5xx**: Indicates some system error. The client **SHOULD** interpret a 5xx response to indicate an unexpected error occurred on the part of the server, with the implication that it may be appropriate to resubmit the original operation. * The server **SHOULD** return an [OperationOutcome](http://hl7.org/fhir/operationoutcome.html) with additional error information if the response code is 400 or greater. For example, if the payer does not know the claim or prior authorization, the OperationOutcome can alert the submitter to check whether they sent it to the wrong payer. See the [Attachments](attachments.html) page for additional guidance and examples.

Input Parameters (9)

Name	Type	Card.	Description
`TrackingId`*	Identifier	1..1	An identifier that ties the attachment(s) back to the claim or prior authorization. This value is referred to as the "tracking control number" In unsolicited claim attachments, the provider assigns the tracking control number on the claim and also on the submitted attachments for that claim for association. In solicited claim attachments, the payer assigns the tracking control number and sends it to the provider with the request for additional information for that specific claim. Similarly, for prior authorizations, the prior-auth tracking control number is provider assigned when the attachments are sent upon prior auth generation as unsolicited attachments, and the prior auth tracking control number is assigned and communicated by the payer when the attachments are in response to a request for additional documentation.
`AttachTo`*	code binding: required	1..1	A value of either "claim" or "preauthorization" to communicate what the additional information is needed for. This is known by the provider when submitting unsolicited attachments and communicated to the provider through the request for solicited attachments.
`PayerId`	Identifier	0..1	The receiving payer identifier. It may be required, because the endpoint may support multiple payers. Currently, there is no standard way to obtain the payer identifiers and implementers will need to obtain them “out of band” when submitting unsolicited attachments. For solicited attachments this value is communicated to the provider through the request.
`OrganizationId`	Identifier	0..1	Sending organization/location identifier (e.g., Type 2 NPI). This is assumed to be known by the provider when submitting unsolicited attachments. For solicited attachments this value is communicated to the provider through the request. A ProviderId parameter or OrganizationId parameter or both SHALL be present.
`ProviderId`	Identifier	0..1	Sending provider identifier (e.g.,Type 1 NPI). This is assumed to be known by the provider when submitting unsolicited attachments. For solicited attachments this value is communicated to the provider through the request. A ProviderId parameter or OrganizationId parameter or both SHALL be present.
`MemberId`*	Identifier	1..1	Patient member identifier. This is assumed to be known by the provider when submitting unsolicited attachments. For solicited attachments this value is communicated to the provider through the request. This identifier can be either the Payer assigned Member ID or a provider assigned "Patient Account Number" for an unsolicited attachment for prior authorization.
`ServiceDate`	dateTime	0..1	Date of service or starting date of the service for the claim or prior authorization. This parameter SHALL be present and precise to the day if the attachment is for a claim. It is optional if the attachment is for prior authorization. This is assumed to be known by the provider when submitting unsolicited attachments. For solicited attachments this value is communicated to the provider through the request.
`Attachment`*	any	1..*	The attachments that are communicated for a claim or prior authorization. They are applied to the LineItem (line items) and/or Code parameters if present. If no LineItem is present, then the attachment is applied to the entire claim or prior authorization.
`Final`	boolean	0..1	Flag to indicate whether the operation is the last attachment submission (solicited or unsolicited) for the claim or prior authorization. If Final = "true", the Data Source has no more attachments to submit. This is the default meaning if this parameter is omitted. If Final = "false", the Data Source expects to submit more attachments in subsequent operations. Payers typically anticipate a single submission and may discourage multiple submissions.

Additional Information

Version: 2.1.0
Date: 2021-12-02T20:24:41-08:00