{"info":{"title":"Medical Network FHIR Coverage Requirement Discovery API","description":"Retrieves the list of available CDS services from the discovery endpoint based on the [CDS Hooks](https://build.fhir.org/ig/HL7/davinci-crd/en/) specification.","version":"v1"},"openapi":"3.1.0","servers":[{"url":"https://sandbox-apigw.optum.com/medicalnetwork/priorauth/v2","description":"Optum"}],"tags":[{"name":"Prior Auth","description":"Prior Auth"}],"paths":{"/healthcheck":{"get":{"tags":["Healthcheck"],"summary":"Healthcheck","description":"Checks whether the API is available.","operationId":"healthcheck_get","security":[],"responses":{"200":{"description":"API is available.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"UP"}}}}}}},"/crd/{hook_id}":{"post":{"operationId":"crd_post_cds_hook_priorauth_v1_fhir_2_1_crd__hook_id__post","parameters":[{"in":"path","name":"hook_id","required":true,"schema":{"title":"Hook Id","type":"string","enum":["order-sign","order-dispatch","appointment-book"]},"description":"CDS Hook identifier for the CRD service invocation. The value must match the **hook** value in the request body.","example":"order-sign"},{"in":"header","name":"Authorization","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"},"description":"Bearer Your-Access-Token<br/>Example: <b>Bearer eyJraWQiOiIxIiwid…</b>"},{"in":"header","name":"x-mock-scenario","description":"Optional sandbox testing header used to simulate predefined responses.","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Mock-Scenario"}},{"in":"header","name":"x-optum-trace-id","description":"Unique identifier used to trace and correlate requests across Optum systems for troubleshooting and support.","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Optum-Trace-Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CDSServiceRequest"}}},"required":true},"responses":{"200":{"description":"Successful CDS Hooks response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CDSServiceResponse"},"example":{"cards":[{"summary":"Coverage requirements found","detail":"Review the applicable coverage requirements for the requested service.","indicator":"info","source":{"label":"Medical Network FHIR Coverage Requirement Discovery API"}}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"},"example":{"detail":[{"loc":["body","context","patientId"],"msg":"Field required","type":"missing","input":null,"ctx":{}}]}}}}},"summary":"CRD Post CDS Hook","tags":["CRD"]}}},"components":{"schemas":{"CDSServiceRequest":{"properties":{"context":{"$ref":"#/components/schemas/Context"},"fhirAuthorization":{"anyOf":[{"$ref":"#/components/schemas/FHIRAuthorization"},{"type":"null"}]},"fhirServer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base URL of the caller's EHR's FHIR server.","title":"Fhirserver"},"hook":{"$ref":"#/components/schemas/HookType","description":"The CDS Hook identifier that triggered this call. Must match the value supplied in the request body's **hook_id** field as mentioned in the hook_id field."},"hookInstance":{"description":"A unique UUID generated by the CDS Hooks client for each invocation of a CDS Hook.","title":"Hookinstance","type":"string"}},"required":["hook","hookInstance","context"],"title":"CDSServiceRequest","type":"object"},"Context":{"properties":{"draftOrders":{"anyOf":[{"$ref":"#/components/schemas/src__models__fhir21__crd__Bundle"},{"type":"null"}]},"encounterId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The FHIR Encounter.id of the current patient visit, appointment, admission, or clinical interaction.","title":"Encounterid"},"patientId":{"description":"The FHIR Patient.id of the current patient.","title":"Patientid","type":"string"},"selections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"References to FHIR resources in draftOrders that the user selected.","title":"Selections"},"userId":{"description":"The ID of the ordering provider (Practitioner or PractitionerRole).","title":"Userid","type":"string"}},"required":["userId","patientId"],"title":"Context","type":"object"},"FHIRAuthorization":{"properties":{"access_token":{"title":"Access Token","type":"string"},"expires_in":{"title":"Expires In","type":"integer"},"scope":{"title":"Scope","type":"string"},"subject":{"title":"Subject","type":"string"},"token_type":{"title":"Token Type","type":"string"}},"required":["access_token","token_type","expires_in","scope","subject"],"title":"FHIRAuthorization","description":"This token can be used by the CRD service to access the caller's FHIR server for additional patient, coverage, or clinical information when needed.","type":"object"},"HookType":{"enum":["order-sign","order-dispatch","appointment-book"],"title":"HookType","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ServiceRequest":{"additionalProperties":true,"description":"HL7 FHIR R4 ServiceRequest.","properties":{},"title":"ServiceRequest","type":"object"},"src__models__fhir21__crd__Bundle":{"description":"HL7 FHIR R4 Bundle containing draft clinical orders supplied by the calling CDS Hooks client. Typically includes one or more ServiceRequest resources used to evaluate coverage requirements and prior authorization needs.","properties":{"entry":{"anyOf":[{"items":{"$ref":"#/components/schemas/src__models__fhir21__crd__Entry"},"type":"array"},{"type":"null"}],"title":"Entry"},"resourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resourcetype"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"title":"Bundle","type":"object"},"src__models__fhir21__crd__Entry":{"properties":{"fullUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullurl"},"resource":{"anyOf":[{"$ref":"#/components/schemas/ServiceRequest"},{"type":"null"}]}},"title":"Entry","type":"object"},"ValidationError":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"CDSServiceResponse":{"type":"object","title":"CDSServiceResponse","description":"Response returned by the CDS Hooks service.","properties":{"cards":{"type":"array","description":"Cards returned by the CDS service.","items":{"$ref":"#/components/schemas/CDSCard"}}},"required":["cards"]},"CDSCard":{"type":"object","title":"CDSCard","description":"A CDS Hooks card containing guidance for the user.","properties":{"summary":{"type":"string","description":"Brief summary of the card."},"detail":{"type":"string","description":"Detailed information presented by the card."},"indicator":{"type":"string","description":"Urgency or importance of the card.","enum":["info","warning","critical"]},"source":{"$ref":"#/components/schemas/CDSCardSource"}},"required":["summary","indicator","source"]},"CDSCardSource":{"type":"object","title":"CDSCardSource","description":"Source of the CDS Hooks card.","properties":{"label":{"type":"string","description":"Human-readable name of the card source."}},"required":["label"]}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[{"bearerAuth":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}