{"info":{"title":"Medical Network Clinical Data Exchange API","description":"Submits clinical attachments in support of prior authorization or claim review requests using the HL7 FHIR Clinical Data Exchange (CDEx) attachment submission workflow. The API accepts a FHIR Parameters resource containing identifiers, service information, and one or more DocumentReference attachments.","version":"v1"},"openapi":"3.0.3","servers":[{"url":"https://sandbox-apigw.optum.com/medicalnetwork/priorauth/v2","description":"Optum"}],"tags":[{"name":"CDEx","description":"FHIR Clinical Data Exchange attachment submission operations."},{"name":"Health Check","description":"API availability and operational-status endpoint."}],"paths":{"/priorauth/v1/fhir/2.1/cdex/submit-attachment":{"post":{"operationId":"submit_attachment_priorauth_v1_fhir_2_1_cdex_submit_attachment_post","tags":["CDEx"],"summary":"Submit Attachment","description":"Submits clinical documentation for a prior authorization or claim review request. The request is a FHIR Parameters resource containing tracking and business identifiers, the target workflow, service-date information, and an Attachment parameter. Each attachment contains a document-type code and a FHIR DocumentReference resource.","parameters":[{"in":"header","name":"x-optum-trace-id","required":false,"schema":{"title":"X-Optum-Trace-Id","type":"string","nullable":true},"description":"Optional client-supplied correlation identifier used to trace the request across systems.","example":"8f14e45f-ea7d-4d2b-9c6f-3d96f4a8b123"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAttachmentRequest"},"example":{"singleAttachmentInlineBase64":{"summary":"Example: submitting one supporting document, with the file content included directly in the request.","value":{"resourceType":"Parameters","parameter":[{"name":"TrackingId","valueIdentifier":{"system":"http://example.org/tracking","value":"TRACK-E2E-001"}},{"name":"AttachTo","valueCode":"prior-auth"},{"name":"RequestId","valueString":"REQ-E2E-001"},{"name":"PayerId","valueIdentifier":{"system":"http://example.org/payer","value":"PAYER-99"}},{"name":"ProviderId","valueIdentifier":{"system":"http://example.org/provider","value":"PROV-77"}},{"name":"MemberId","valueIdentifier":{"system":"http://example.org/member","value":"MBR-55"}},{"name":"ServiceDate","valueDate":"2026-07-01"},{"name":"Attachment","part":[{"name":"LineItem","valueString":"1"},{"name":"Code","valueCodeableConcept":{"coding":[{"system":"http://loinc.org","code":"18748-4","display":"Diagnostic imaging study"}]}},{"name":"Content","resource":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"text/plain","title":"e2e-attachment.txt","creation":"2026-07-01T10:00:00Z","data":"SGVsbG8gQ0RFeCEgVGhpcyBpcyBhIHNhbXBsZSBiYXNlNjQgYXR0YWNobWVudC4="}}]}}]}]}},"multipleAttachmentsInlineBase64":{"summary":"Example: submitting two supporting documents in a single request.","value":{"resourceType":"Parameters","parameter":[{"name":"TrackingId","valueIdentifier":{"system":"http://example.org/tracking","value":"TRACK-E2E-002"}},{"name":"AttachTo","valueCode":"prior-auth"},{"name":"RequestId","valueString":"REQ-E2E-002"},{"name":"PayerId","valueIdentifier":{"system":"http://example.org/payer","value":"PAYER-99"}},{"name":"ProviderId","valueIdentifier":{"system":"http://example.org/provider","value":"PROV-77"}},{"name":"MemberId","valueIdentifier":{"system":"http://example.org/member","value":"MBR-55"}},{"name":"ServiceDate","valueDate":"2026-07-01"},{"name":"Attachment","part":[{"name":"LineItem","valueString":"1"},{"name":"Code","valueCodeableConcept":{"coding":[{"system":"http://loinc.org","code":"18748-4","display":"Diagnostic imaging study"}]}},{"name":"Content","resource":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"text/plain","title":"e2e-attachment-one.txt","creation":"2026-07-01T10:00:00Z","data":"VGhpcyBpcyBhdHRhY2htZW50IE9ORSAtIGxpbmUgaXRlbSAxLg=="}}]}}]},{"name":"Attachment","part":[{"name":"LineItem","valueString":"2"},{"name":"Code","valueCodeableConcept":{"coding":[{"system":"http://loinc.org","code":"28570-0","display":"Procedure note"}]}},{"name":"Content","resource":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"text/plain","title":"e2e-attachment-two.txt","creation":"2026-07-01T10:05:00Z","data":"VGhpcyBpcyBhdHRhY2htZW50IFRXTyAtIGxpbmUgaXRlbSAyLg=="}}]}}]}]}},"singleAttachmentByUrl":{"summary":"Example: submitting one supporting document by providing a web link to where it is hosted, instead of including the file content directly.","value":{"resourceType":"Parameters","parameter":[{"name":"TrackingId","valueIdentifier":{"system":"https://example.org/identifiers/tracking-id","value":"TRK123456789"}},{"name":"AttachTo","valueCode":"prior-auth"},{"name":"RequestId","valueString":"PA-REQUEST-12345"},{"name":"MemberId","valueIdentifier":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"}},{"name":"ServiceDate","valueDate":"2026-09-10"},{"name":"Attachment","part":[{"name":"LineItem","valueString":"1"},{"name":"Code","valueCodeableConcept":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note"}]}},{"name":"Content","resource":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]}}]}]}}}}},"required":true,"description":"FHIR Parameters resource containing the identifiers, service information, and clinical attachment to submit."},"responses":{"200":{"description":"Acknowledgement for Attachment is received","headers":{"x-optum-trace-id":{"description":"The reference number for this submission, for your records.","schema":{"type":"string"},"example":"8f14e45f-ea7d-4d2b-9c6f-3d96f4a8b123"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAttachmentResponse"},"example":{"resourceType":"OperationOutcome","language":"en-US","issue":[{"severity":"success","code":"success","details":{"coding":[{"system":"http://hl7.org/fhir/R4/valueset-operation-outcome.html","code":"MSG_CREATED","display":"Acknowledgement message"}],"text":"Acknowledgement for Attachment is received"}}]}}}},"400":{"description":"The request could not be processed because it is malformed or contains invalid business data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"The request payload is invalid."}]}}}},"401":{"description":"Authentication failed because the bearer token is missing, invalid, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"security","diagnostics":"A valid bearer token is required."}]}}}},"422":{"description":"The request body is syntactically valid but fails schema validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"},"example":{"detail":[{"loc":["body","parameter"],"msg":"Missing required parameter: TrackingId","type":"value_error"}]}}}},"500":{"description":"The server encountered an unexpected condition while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"exception","diagnostics":"An unexpected error occurred."}]}}}}},"security":[{"bearerAuth":[]}]}},"/priorauth/v1/healthcheck":{"get":{"tags":["Health Check"],"summary":"Health Check","description":"Returns the availability status, service name, and API version.","operationId":"get_healthcheck","security":[],"responses":{"200":{"description":"The API is available and operating normally.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthCheckResponse"},"example":{"status":"OK","version":"v1"}}}},"500":{"description":"The API is unavailable because of an unexpected server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Server Error","message":"The service is currently unavailable."}}}}}}}},"components":{"schemas":{"AttachmentPart":{"description":"A sub-parameter within the Attachment parameter of $submit-attachment.","properties":{"name":{"$ref":"#/components/schemas/AttachmentPartName"},"resource":{"description":"Used for Content — the DocumentReference payload.","allOf":[{"$ref":"#/components/schemas/DocumentReference"}],"nullable":true,"example":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]}},"valueCodeableConcept":{"description":"Used for Code — LOINC or other document type code.","allOf":[{"$ref":"#/components/schemas/src__models__fhir21__cdex__CodeableConcept"}],"nullable":true,"example":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","userSelected":true}],"text":"Outpatient clinical note"},"default":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","userSelected":true}],"text":"Outpatient clinical note"}},"valueString":{"description":"Value used when the attachment part name is LineItem.","title":"Valuestring","type":"string","nullable":true,"example":"1","default":"1"}},"required":["name"],"title":"AttachmentPart","type":"object","example":{"name":"LineItem","valueString":"1"}},"AttachmentPartName":{"description":"Supported sub-parameter names within an Attachment parameter.","enum":["LineItem","Code","Content"],"title":"AttachmentPartName","type":"string","example":"LineItem","default":"LineItem"},"AttachTo":{"description":"Target context for the submitted attachment.","enum":["claim","prior-auth"],"title":"AttachTo","type":"string","example":"prior-auth","default":"prior-auth"},"Attachment":{"description":"FHIR Attachment datatype. Provide either `url` (preferred for large files) or inline base64 `data`, not both. `contentType` is required whenever `data` is present.","type":"object","properties":{"contentType":{"title":"Contenttype","type":"string","nullable":true,"description":"MIME type of the attachment, e.g. application/pdf, image/jpeg, image/png, image/tiff, or application/dicom.","example":"application/pdf"},"data":{"title":"Data","type":"string","format":"byte","nullable":true,"description":"Base64-encoded inline attachment content. Mutually exclusive with url.","example":"JVBERi0xLjQKJcOkw7zDtsO...(truncated base64)"},"url":{"title":"Url","type":"string","format":"uri","nullable":true,"description":"Location of the attachment content. Mutually exclusive with data.","example":"https://example.org/documents/clinical-progress-note.pdf"},"title":{"title":"Title","type":"string","nullable":true,"example":"Clinical Progress Note"},"creation":{"title":"Creation","type":"string","format":"date-time","nullable":true,"description":"Date/time the attachment content was created."}},"additionalProperties":true},"DocumentReference":{"additionalProperties":true,"description":"HL7 FHIR R4 DocumentReference resource (flexible).","properties":{"content":{"title":"Content","items":{"type":"object","properties":{"attachment":{"$ref":"#/components/schemas/Attachment"}},"required":["attachment"],"additionalProperties":true},"type":"array","minItems":1,"example":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}],"default":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]},"resourceType":{"default":"DocumentReference","title":"Resourcetype","type":"string","enum":["DocumentReference"],"example":"DocumentReference"},"status":{"title":"Status","type":"string","nullable":true,"enum":["current","superseded","entered-in-error"],"example":"current","default":"current"}},"required":["resourceType","status","content"],"title":"DocumentReference","type":"object","example":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]},"default":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ParameterItem":{"description":"A single named parameter within the FHIR Parameters resource.","properties":{"name":{"$ref":"#/components/schemas/src__models__fhir21__cdex__ParameterName"},"part":{"description":"Sub-parameters of the Attachment parameter.","title":"Part","items":{"$ref":"#/components/schemas/AttachmentPart"},"type":"array","nullable":true,"example":[{"name":"LineItem","valueString":"1"}],"default":[{"name":"LineItem","valueString":"1"}]},"valueCode":{"description":"Value used when name is AttachTo. Allowed values are claim and prior-auth.","allOf":[{"$ref":"#/components/schemas/AttachTo"}],"nullable":true,"example":"prior-auth","default":"prior-auth"},"valueDate":{"description":"Value used when name is ServiceDate and a single date applies. Format: YYYY-MM-DD.","title":"Valuedate","type":"string","nullable":true,"format":"date","example":"2026-09-10","default":"2026-09-10"},"valueIdentifier":{"description":"Used for TrackingId, PayerId, OrganizationId, ProviderId, MemberId.","allOf":[{"$ref":"#/components/schemas/src__models__fhir21__cdex__Identifier"}],"nullable":true,"example":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"},"default":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"}},"valuePeriod":{"description":"Used for ServiceDate when a date range applies.","allOf":[{"$ref":"#/components/schemas/Period"}],"nullable":true,"example":{"start":"2026-09-10","end":"2026-09-10"},"default":{"start":"2026-09-10","end":"2026-09-10"}},"valueString":{"description":"Value used when name is RequestId. Example payer request identifier: PA-REQUEST-12345.","title":"Valuestring","type":"string","nullable":true,"example":"PA-REQUEST-12345","default":"PA-REQUEST-12345"}},"required":["name"],"title":"ParameterItem","type":"object","example":{"name":"RequestId","valueString":"PA-REQUEST-12345"}},"Period":{"description":"FHIR Period datatype.","properties":{"end":{"title":"End","type":"string","nullable":true,"format":"date","example":"2026-09-10","default":"2026-09-10"},"start":{"title":"Start","type":"string","nullable":true,"format":"date","example":"2026-09-10","default":"2026-09-10"}},"title":"Period","type":"object","example":{"start":"2026-09-10","end":"2026-09-10"},"default":{"start":"2026-09-10","end":"2026-09-10"}},"src__models__fhir21__cdex__CodeableConcept":{"description":"FHIR CodeableConcept datatype.","properties":{"coding":{"title":"Coding","items":{"$ref":"#/components/schemas/src__models__fhir21__cdex__Coding"},"type":"array","nullable":true,"example":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true}],"default":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true}]},"text":{"title":"Text","type":"string","nullable":true,"example":"Outpatient clinical note","default":"Outpatient clinical note"}},"title":"CodeableConcept","type":"object","example":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true}],"text":"Outpatient clinical note"},"default":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true}],"text":"Outpatient clinical note"}},"src__models__fhir21__cdex__Coding":{"description":"FHIR Coding datatype.","properties":{"code":{"title":"Code","type":"string","nullable":true,"example":"34108-1","default":"34108-1"},"display":{"title":"Display","type":"string","nullable":true,"example":"Outpatient Note","default":"Outpatient Note"},"system":{"title":"System","type":"string","nullable":true,"example":"http://loinc.org","default":"http://loinc.org"},"userSelected":{"title":"Userselected","type":"boolean","nullable":true,"example":true,"default":true},"version":{"title":"Version","type":"string","nullable":true,"example":"2.76","default":"2.76"}},"title":"Coding","type":"object","example":{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true},"default":{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","version":"2.76","userSelected":true}},"src__models__fhir21__cdex__Identifier":{"description":"FHIR Identifier datatype.","properties":{"system":{"title":"System","type":"string","format":"uri","nullable":true,"example":"https://example.org/identifiers/member-id","default":"https://example.org/identifiers/member-id"},"value":{"title":"Value","type":"string","nullable":true,"example":"MEMBER987654","default":"MEMBER987654"}},"title":"Identifier","type":"object","example":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"},"default":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"}},"src__models__fhir21__cdex__ParameterName":{"description":"Supported parameter names in $submit-attachment.","enum":["TrackingId","AttachTo","RequestId","PayerId","OrganizationId","ProviderId","MemberId","ServiceDate","Attachment"],"title":"ParameterName","type":"string","example":"TrackingId","default":"TrackingId"},"SubmitAttachmentRequest":{"additionalProperties":true,"description":"FHIR Parameters resource for the $submit-attachment operation request.","properties":{"parameter":{"description":"List of named parameters.","items":{"$ref":"#/components/schemas/ParameterItem"},"minItems":1,"title":"Parameter","type":"array"},"resourceType":{"default":"Parameters","description":"Fixed to Parameters.","title":"Resourcetype","type":"string","enum":["Parameters"],"example":"Parameters"}},"required":["parameter"],"title":"SubmitAttachmentRequest","type":"object","example":{"resourceType":"Parameters","parameter":[{"name":"TrackingId","valueIdentifier":{"system":"https://example.org/identifiers/tracking-id","value":"TRK123456789"}},{"name":"AttachTo","valueCode":"prior-auth"},{"name":"RequestId","valueString":"PA-REQUEST-12345"},{"name":"PayerId","valueIdentifier":{"system":"https://example.org/identifiers/payer-id","value":"PAYER001"}},{"name":"OrganizationId","valueIdentifier":{"system":"https://example.org/identifiers/organization-id","value":"ORG10001"}},{"name":"ProviderId","valueIdentifier":{"system":"http://hl7.org/fhir/sid/us-npi","value":"1234567893"}},{"name":"MemberId","valueIdentifier":{"system":"https://example.org/identifiers/member-id","value":"MEMBER987654"}},{"name":"ServiceDate","valueDate":"2026-09-10"},{"name":"Attachment","part":[{"name":"LineItem","valueString":"1"},{"name":"Code","valueCodeableConcept":{"coding":[{"system":"http://loinc.org","code":"34108-1","display":"Outpatient Note","userSelected":true}],"text":"Outpatient clinical note"}},{"name":"Content","resource":{"resourceType":"DocumentReference","status":"current","content":[{"attachment":{"contentType":"application/pdf","title":"Clinical Progress Note","url":"https://example.org/documents/clinical-progress-note.pdf"}}]}}]}]}},"SubmitAttachmentResponse":{"additionalProperties":true,"description":"Empty FHIR Parameters resource returned on successful $submit-attachment.","properties":{"resourceType":{"default":"Parameters","description":"Fixed to Parameters.","title":"Resourcetype","type":"string","example":"Parameters"}},"title":"SubmitAttachmentResponse","type":"object","example":{"resourceType":"Parameters"}},"ValidationError":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array","example":["body","parameter"],"default":["body","parameter"]},"msg":{"title":"Message","type":"string","example":"Field required","default":"Field required"},"type":{"title":"Error Type","type":"string","example":"value_error","default":"value_error"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"HealthCheckResponse":{"type":"object","description":"API availability information.","properties":{"status":{"type":"string","description":"Current API availability status.","example":"OK"},"version":{"type":"string","description":"Published API version.","example":"v1"}},"required":["status","version"]},"ErrorResponse":{"type":"object","description":"Standard error response.","properties":{"error":{"type":"string","description":"Short error category.","example":"Bad Request","default":"Bad Request"},"message":{"type":"string","description":"Human-readable explanation of the error.","example":"The request payload is invalid.","default":"The request payload is invalid."},"traceId":{"type":"string","description":"Optional correlation identifier for troubleshooting.","nullable":true,"example":"8f14e45f-ea7d-4d2b-9c6f-3d96f4a8b123","default":"8f14e45f-ea7d-4d2b-9c6f-3d96f4a8b123"}},"required":["error","message"]},"OperationOutcomeIssue":{"description":"A single issue within a FHIR OperationOutcome.","type":"object","properties":{"severity":{"title":"Severity","type":"string","enum":["fatal","error","warning","information"],"example":"error"},"code":{"title":"Code","type":"string","enum":["invalid","structure","required","value","security","forbidden","not-supported","not-found","conflict","business-rule","transient","exception","timeout","throttled"],"example":"invalid"},"diagnostics":{"title":"Diagnostics","type":"string","nullable":true,"example":"The request payload is invalid."}},"required":["severity","code"]},"OperationOutcome":{"description":"HL7 FHIR R4 OperationOutcome resource returned for CDEx error conditions.","type":"object","properties":{"resourceType":{"title":"Resourcetype","type":"string","enum":["OperationOutcome"],"default":"OperationOutcome","example":"OperationOutcome"},"issue":{"title":"Issue","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OperationOutcomeIssue"}}},"required":["resourceType","issue"],"additionalProperties":true,"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"The request payload is invalid."}]}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter the JWT bearer access token used to authorize API requests."}}},"security":[{"bearerAuth":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}