This page is part of the Da Vinci Clinical Documentation Exchange (v1.0.0: STU1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment | Version: 1.0.0 | |||
Draft as of 2021-12-02 | Computable Name: SubmitAttachment |
This operation is used to submit attachments (aditional information) for Claims or Prior Authorization. This operation accepts the clinical/administrative attachments and the necessary information needed to re-associate them to the claim or prior authorization, and returns a transaction layer HTTP response. This operation can be used by any HTTP endpoint, not just FHIR RESTful servers.
The input parameters are:
There are no output parameters.
The following page content is DRAFT. It has not yet undergone HL7 balloting.
OPERATION: SubmitAttachment
The official URL for this operation definition is:
http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment
This operation is used to submit attachments (aditional information) for Claims or Prior Authorization. This operation accepts the clinical/administrative attachments and the necessary information needed to re-associate them to the claim or prior authorization, and returns a transaction layer HTTP response. This operation can be used by any HTTP endpoint, not just FHIR RESTful servers.
The input parameters are:
There are no output parameters.
URL: [base]/$submit-attachment
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
IN | AttachTo | 1..1 | code | http://hl7.org/fhir/us/davinci-cdex/ValueSet/cdex-attachment-reason (Required) | Whether the additional information is needed for a claim (unsolicited or solicited) or for prior authorization. |
IN | TargetId | 1..1 | string | Claim/prior authorization identifier value referred to as the "re-association tracking control numbers"* | |
IN | ItemId | 0..* | string | Claim/prior authorization identifier that uniquely reference a line item in the context of the claim or prior authorization. | |
IN | OrganizationId | 1..1 | Identifier | Sending organization/location Identifier (e.g., NPI) | |
IN | ProviderId | 1..1 | Identifier | Sending provider identifier (e.g., NPI) | |
IN | MemberId | 1..1 | Identifier | Patient member identifier | |
IN | ServiceDate | 0..1 | date | 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 a prior authorization. | |
IN | Attachment | 1..* | Resource | The actual attachments as FHIR resources for Claims or Prior Authorization. Note that non-FHIR data formats are attached to or referenced by DocumentReference. Servers SHALL support DocumentReference resource type and SHOULD support other types. |
*Note that an Unsolicited Claim attachment implies that the provider assigns the tracking control number on the claim and also on the submitted attachments for that claim for re-association. Solicited Claim attachments are when the payer assigns the Claim control number and sends the provider a request for additional information for that specific claim. Similarly for Prior Authorization, the prior auth identifier is provider assigned when the attachments are sent upon prior auth generation, and the prior auth identifier is the payer assigned control number when the attachments are in response to a request for additional information by the payer.
The following rules apply when using $submit-attachment
:
POST
transactions - any other HTTP method will result in an HTTP errorAttachment
parameter, Servers SHALL support DocumentReference resource type and SHOULD support other types.
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.See the Attachments page for additional guidance and examples.