Da Vinci Clinical Data Exchange (CDex)
2.0.0 - STU2
Da Vinci Clinical Data Exchange (CDex)
2.0.0 - STU2
This page is part of the Da Vinci Clinical Documentation Exchange (v2.0.0: STU2) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "OperationDefinition",
"id" : "submit-attachment",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/$submit-attachment</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>TrackingId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>An identifier that ties the attachment(s) back to the claim or prior authorization. This value is referred to as the "tracking control number"</p>\n<p>In <em>unsolicited</em> claim attachments, the provider assigns the tracking control number on the claim and also on the submitted attachments for that claim for association. In <em>solicited</em> 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 <em>unsolicited</em> 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.</p>\n</div></td></tr><tr><td>IN</td><td>AttachTo</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-cdex-claim-use.html\">CDex Claim Use Value Set</a> (Required)</td><td><div><p>A value of either "claim" or "preauthorization" to communicate what the additional information is needed for. This is known by the provider when submitting <em>unsolicited</em> attachments and communicated to the provider through the request for <em>solicited</em> attachments.</p>\n</div></td></tr><tr><td>IN</td><td>PayerId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>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 <em>unsolicited</em> attachments. For <em>solicited</em> attachments this value is communicated to the provider through the request.</p>\n</div></td></tr><tr><td>IN</td><td>OrganizationId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Sending organization/location identifier (e.g., Type 2 NPI). This is assumed to be known by the provider when submitting <em>unsolicited</em> attachments. For <em>solicited</em> attachments this value is communicated to the provider through the request. A ProviderId parameter or OrganizationId parameter or both <strong>SHALL</strong> be present.</p>\n</div></td></tr><tr><td>IN</td><td>ProviderId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Sending provider identifier (e.g.,Type 1 NPI). This is assumed to be known by the provider when submitting <em>unsolicited</em> attachments. For <em>solicited</em> attachments this value is communicated to the provider through the request. A ProviderId parameter or OrganizationId parameter or both <strong>SHALL</strong> be present.</p>\n</div></td></tr><tr><td>IN</td><td>MemberId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Patient member identifier. This is assumed to be known by the provider when submitting <em>unsolicited</em> attachments. For <em>solicited</em> 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 <em>unsolicited</em> attachment for prior authorization.</p>\n</div></td></tr><tr><td>IN</td><td>ServiceDate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Date of service or starting date of the service for the claim or prior authorization. This parameter <strong>SHALL</strong> 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 <em>unsolicited</em> attachments. For <em>solicited</em> attachments this value is communicated to the provider through the request.</p>\n</div></td></tr><tr><td>IN</td><td>Attachment</td><td/><td>1..*</td><td></td><td/><td><div><p>The attachments that are communicated for a claim or prior authorization. They are applied to the LineItem (line items) and/or Code (LOINC) parameters if present. If no LineItem is present, then the attachment is applied to the entire claim or prior authorization.</p>\n</div></td></tr><tr><td>IN</td><td>Attachment.LineItem</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Claim/prior authorization line item for service in the claim or prior authorization. It may be present when submitting <em>unsolicited</em> attachments. For a <em>solicited</em> claim or claim authorization attachment, this value is the same as the line items communicated in the request.</p>\n</div></td></tr><tr><td>IN</td><td>Attachment.Code</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td>http://loinc.org/vs/valid-hl7-attachment-requests (Extensible)</td><td><div><p>LOINC code to identify the specific kind of information being communicated (e.g., a discharge summary or diagnostic imaging report). This value set includes LOINC terms that can be sent by a payer as part of an HL7 attachment request for additional information. It has been curated by the HL7 Payer/Provider Information Exchange (PIE) Work Group. More information about using LOINC in HIPAA attachments and the source of this value set can be found at https://loinc.org/attachments/. It <strong>SHOULD</strong> be present when submitting <em>unsolicited</em> attachments. For <em>solicited</em> attachments, this value is the same as the LOINC communicated when requesting attachments using attachments codes. When requesting attachments using Questionnaire, there is no code in the request and the code is typically not present in the response.</p>\n</div></td></tr><tr><td>IN</td><td>Attachment.Content</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Attachment as a FHIR resource. Non-FHIR attachment data is conveyed using the <a href=\"http://hl7.org/fhir/documentreference.html\">DocumentReference</a> or <a href=\"http://hl7.org/fhir/binary.html\">Binary</a> resource. Servers <strong>SHALL</strong> support the DocumentReference resource type and <strong>SHOULD</strong> support other types. If Servers support requesting attachments with Questionnaire, then the <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">SDC Questionnaire Response Profile</a> <strong>SHALL</strong> be supported and the <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt\">SDC Adaptive Questionnaire Response Profile</a> <strong>SHOULD</strong> be supported.</p>\n</div></td></tr><tr><td>IN</td><td>Final</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>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.</p>\n</div></td></tr></table><div><p>The following rules apply when using <code>$submit-attachment</code>:</p>\n<ul>\n<li>The operation's endpoint <strong>SHALL</strong>only accept <code>POST</code> transactions - any other HTTP method <strong>SHALL</strong> result in an HTTP error.</li>\n<li>A ProviderId parameter or OrganizationId parameter or both <strong>SHALL</strong> be present.</li>\n<li>The ServiceDate parameter <strong>SHALL</strong> be present and precise to the day if the attachment is for a claim. It is optional if the attachment is for prior authorization.</li>\n<li>The <code>Attachment.LineItem</code> and <code>Attachment.Code</code> parameters are associated with the attachments in <code>Attachment.Content</code>. If <code>Attachment.LineItem</code> is not present, then the attachment is associated with the entire claim or prior authorization.</li>\n<li>For the <code>Attachment.Content</code> parameter, Servers <strong>SHALL</strong> support <a href=\"http://hl7.org/fhir/documentreference.html\">DocumentReference</a> resource type and <strong>SHOULD</strong> support other types. If Servers support requesting attachments with <a href=\"http://hl7.org/fhir/questionnaire.html\">Questionnaire</a>, then the <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">SDC Questionnaire Response Profile</a> <strong>SHALL</strong> be supported and the <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt\">SDC Adaptive Questionnaire Response Profile</a> <strong>SHOULD</strong> be supported.\n<ul>\n<li>The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using <code>DocumentReference.attachment.url</code> or the content as inline base64 encoded data using <code>DocumentReference.attachment.data</code>. The server system is not required to support both an address and inline base64 encoded data, but <strong>SHALL</strong> support at least one of these elements.</li>\n<li>These capabilities <strong>SHOULD</strong> be discoverable and documented by the server (for example, in the CapabilityStatement for FHIR Servers).</li>\n</ul>\n</li>\n<li>The default meaning when the <code>Final</code> parameter is omitted is Final="true" - the operation is the last attachment submission (solicited or unsolicited) for the claim or prior authorization.</li>\n<li>When processing the operation, a server may return one of several status codes:\n<ul>\n<li><strong>200 OK</strong>: Indicates that the server has accepted the clinical attachments.\n<ul>\n<li>If the attachments can not be associated with an <em>existing</em> claim or member, the server <strong>SHOULD</strong> return an <a href=\"http://hl7.org/fhir/operationoutcome.html\">OperationOutcome</a> to inform the Data Source that the attachments are being held for a subsequent association to a claim or prior authorization.</li>\n</ul>\n</li>\n<li><strong>4xx</strong>: Indicates some error in the submission. The client <strong>SHOULD</strong> interpret a 4xx response to indicate that there is no point in resubmitting the unaltered operation,</li>\n<li><strong>5xx</strong>: Indicates some system error. The client <strong>SHOULD</strong> 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.</li>\n<li>The server <strong>SHOULD</strong> return an <a href=\"http://hl7.org/fhir/operationoutcome.html\">OperationOutcome</a> 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.</li>\n</ul>\n</li>\n</ul>\n<p>See the <a href=\"attachments.html\">Attachments</a> page for additional guidance and examples.</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment",
"version" : "2.0.0",
"name" : "SubmitAttachment",
"title" : "Submit Attachment Operation",
"status" : "draft",
"kind" : "operation",
"date" : "2021-12-02T20:24:41-08:00",
"publisher" : "HL7 International - Patient Care Work Group",
"contact" : [
{
"name" : "HL7 International - Patient Care Work Group",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
},
{
"system" : "email",
"value" : "patientcare@lists.HL7.org"
}
]
}
],
"description" : "Providers use this [operation](http://hl7.org/fhir/operations.html) 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 necessary information 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.\n\nThe input parameters are:\n1. One or more attachments as FHIR Resources\n - Optionally, one or more unique line item numbers associated with the attachment\n - Optionally, the attachment code used to request for the information\n1. Data elements for the association to the claim/prior authorization\n - A unique identifier that ties the attachment(s) back to the claim or prior authorization. (referred to as the \"re-association tracking control numbers\")*\n - What are the attachments for:\n - Claims\n - Prior Authorizations\n - Optionally, a unique payer identifier\n - A unique organization/location identifier (e.g., [Type 2 NPI](https://www.cms.gov/Outreach-and-Education/Medicare-Learning-Network-MLN/MLNProducts/downloads/NPI-What-You-Need-To-Know.pdf)) and/or unique provider identifier (e.g., [Type 1 NPI](https://www.cms.gov/Outreach-and-Education/Medicare-Learning-Network-MLN/MLNProducts/downloads/NPI-What-You-Need-To-Know.pdf))\n - A unique Patient member identifier\n - A Date of Service\n - A Flag indicating whether the operation is the last attachment submission for the claim or prior authorization.\n\nThere are no output parameters.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"code" : "submit-attachment",
"comment" : "\nThe following rules apply when using `$submit-attachment`:\n* The operation's endpoint **SHALL**only accept `POST` transactions - any other HTTP method **SHALL** result in an HTTP error.\n* A ProviderId parameter or OrganizationId parameter or both **SHALL** be present.\n* 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.\n* The `Attachment.LineItem` and `Attachment.Code` parameters are associated with the attachments in `Attachment.Content`. If `Attachment.LineItem` is not present, then the attachment is associated with the entire claim or prior authorization.\n* 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.\n * 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.\n * These capabilities **SHOULD** be discoverable and documented by the server (for example, in the CapabilityStatement for FHIR Servers).\n* The default meaning when the `Final` parameter is omitted is Final=\"true\" - the operation is the last attachment submission (solicited or unsolicited) for the claim or prior authorization.\n* When processing the operation, a server may return one of several status codes:\n * **200 OK**: Indicates that the server has accepted the clinical attachments.\n * 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 the attachments are being held for a subsequent association to a claim or prior authorization.\n * **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,\n * **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.\n * 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.\n\nSee the [Attachments](attachments.html) page for additional guidance and examples.\n",
"resource" : [
"Claim"
],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "TrackingId",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "An identifier that ties the attachment(s) back to the claim or prior authorization. This value is referred to as the \"tracking control number\"\n\n 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.",
"type" : "Identifier"
},
{
"name" : "AttachTo",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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.",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/us/davinci-cdex/ValueSet/cdex-claim-use"
}
},
{
"name" : "PayerId",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "Identifier"
},
{
"name" : "OrganizationId",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "Identifier"
},
{
"name" : "ProviderId",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "Identifier"
},
{
"name" : "MemberId",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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.",
"type" : "Identifier"
},
{
"name" : "ServiceDate",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "dateTime"
},
{
"name" : "Attachment",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "The attachments that are communicated for a claim or prior authorization. They are applied to the LineItem (line items) and/or Code (LOINC) parameters if present. If no LineItem is present, then the attachment is applied to the entire claim or prior authorization.",
"part" : [
{
"name" : "LineItem",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Claim/prior authorization line item for service in the claim or prior authorization. It may be present when submitting *unsolicited* attachments. For a *solicited* claim or claim authorization attachment, this value is the same as the line items communicated in the request.",
"type" : "string"
},
{
"name" : "Code",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "LOINC code to identify the specific kind of information being communicated (e.g., a discharge summary or diagnostic imaging report). This value set includes LOINC terms that can be sent by a payer as part of an HL7 attachment request for additional information. It has been curated by the HL7 Payer/Provider Information Exchange (PIE) Work Group. More information about using LOINC in HIPAA attachments and the source of this value set can be found at https://loinc.org/attachments/. It **SHOULD** be present when submitting *unsolicited* attachments. For *solicited* attachments, this value is the same as the LOINC communicated when requesting attachments using attachments codes. When requesting attachments using Questionnaire, there is no code in the request and the code is typically not present in the response.",
"type" : "CodeableConcept",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://loinc.org/vs/valid-hl7-attachment-requests"
}
},
{
"name" : "Content",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Attachment as a FHIR resource. Non-FHIR attachment data is conveyed using the [DocumentReference](http://hl7.org/fhir/documentreference.html) or [Binary](http://hl7.org/fhir/binary.html) resource. Servers **SHALL** support the DocumentReference resource type and **SHOULD** support other types. If Servers support requesting attachments with Questionnaire, 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.",
"type" : "Resource"
}
]
},
{
"name" : "Final",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "boolean"
}
]
}
IG © 2023+ HL7 International - Patient Care Work Group. Package hl7.fhir.us.davinci-cdex#2.0.0 based on FHIR 4.0.1. Generated 2023-03-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change