{"openapi":"3.0.1","info":{"title":"Prior Authorization API","description":"Autorización previa CMS-0057-F según Da Vinci PAS. Claim/$submit y Claim/$inquire, validados y enviados al sistema de gestión de utilización del plan. Solo de máquina a máquina, mediante SMART Backend Services.","version":"v1"},"paths":{"/cds-services":{"get":{"tags":["CdsHooks"],"summary":"CDS Hooks discovery: the CRD services and their prefetch templates.","operationId":"crd-discovery","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"CDS Hooks discovery.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdsServices"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/cds-services/{id}":{"post":{"tags":["CdsHooks"],"summary":"Invokes a CRD hook.","operationId":"crd-invoke-hook","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"CDS Hooks cards and system actions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdsHookResponse"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/cds-services/{id}/feedback":{"post":{"tags":["CdsHooks"],"summary":"CDS Hooks 2.0 feedback on cards. Accepted and counted; card outcomes feed\r\nthe CRD metrics the IG describes but no metric store exists yet.","operationId":"crd-feedback","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"Feedback recorded. CDS Hooks 2.0 defines no body."},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Questionnaire/$questionnaire-package":{"post":{"tags":["Dtr"],"summary":"DTR $questionnaire-package.","operationId":"dtrQuestionnairePackage","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The questionnaire package.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Questionnaire/$next-question":{"post":{"tags":["Dtr"],"summary":"SDC $next-question for adaptive questionnaires.","operationId":"dtrNextQuestion","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The adaptive Questionnaire with the next question.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Questionnaire/{id}":{"get":{"tags":["Dtr"],"summary":"Reads a Questionnaire.","operationId":"dtrReadQuestionnaire","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The Questionnaire.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Questionnaire":{"get":{"tags":["Dtr"],"summary":"Searches Questionnaires by url, version, status or context.","operationId":"dtrSearchQuestionnaire","parameters":[{"name":"url","in":"query","schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"A searchset Bundle of Questionnaires.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Library/{id}":{"get":{"tags":["Dtr"],"summary":"Reads a CQL Library served in questionnaire packages.","operationId":"dtrReadLibrary","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The Library.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/ValueSet/{id}":{"get":{"tags":["Dtr"],"summary":"Reads a ValueSet served in questionnaire packages.","operationId":"dtrReadValueSet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The ValueSet.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/ValueSet/$expand":{"get":{"tags":["Dtr"],"summary":"ValueSet/$expand (DTR payer service SHALL).","operationId":"dtrExpandValueSet","parameters":[{"name":"url","in":"query","schema":{"type":"string"}},{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The expanded ValueSet.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"422":{"description":"Rejected as failing validation against the profile, as naming a member MHK does not hold, or as a Commercial member (not-supported).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}},"post":{"tags":["Dtr"],"summary":"ValueSet/$expand (DTR payer service SHALL).","operationId":"dtrExpandValueSet","parameters":[{"name":"url","in":"query","schema":{"type":"string"}},{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The expanded ValueSet.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/QuestionnaireResponse":{"post":{"tags":["Dtr"],"summary":"Accepts a completed QuestionnaireResponse.","operationId":"dtrCreateQuestionnaireResponse","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"201":{"description":"The QuestionnaireResponse as stored.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/QuestionnaireResponse/{id}":{"put":{"tags":["Dtr"],"summary":"Updates (amends) a QuestionnaireResponse previously posted.","operationId":"dtrUpdateQuestionnaireResponse","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The QuestionnaireResponse as updated.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/health":{"get":{"tags":["Conformance"],"summary":"Returns service liveness, build provenance, and the sanitized live MHK dependency result.","operationId":"get-health","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}}}}},"/metadata":{"get":{"tags":["Metadata"],"summary":"Returns the FHIR R4 CapabilityStatement for this facade.","operationId":"get-metadata","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The server's CapabilityStatement.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/CapabilityStatement"}}}}}}},"/mhk/notification":{"post":{"tags":["MhkNotification"],"summary":"Receives one HealthLake subscription notification (handshake, heartbeat or event).","operationId":"mhkNotificationReceive","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"Acknowledged. No body."},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}}}}},"/Claim/$submit":{"post":{"tags":["Pas"],"summary":"Submits a prior authorization request.","operationId":"submitPriorAuthorization","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"PAS Response Bundle. The ClaimResponse is the first entry.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/PasResponseBundle"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"422":{"description":"Rejected as failing validation against the profile, as naming a member MHK does not hold, or as a Commercial member (not-supported).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"502":{"description":"MHK refused the request in a way the caller cannot act on. No body."},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Claim/$inquire":{"post":{"tags":["Pas"],"summary":"Inquires on the status of a prior authorization.","operationId":"inquirePriorAuthorization","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"PAS Response Bundle. The ClaimResponse is the first entry.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/PasResponseBundle"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"422":{"description":"Rejected as failing validation against the profile, as naming a member MHK does not hold, or as a Commercial member (not-supported).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"502":{"description":"MHK refused the request in a way the caller cannot act on. No body."},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/$submit-attachment":{"post":{"tags":["PasAttachment"],"summary":"Submits attachments for a pended prior authorization.","operationId":"pasSubmitAttachment","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The attachment was accepted.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"422":{"description":"Rejected as failing validation against the profile, as naming a member MHK does not hold, or as a Commercial member (not-supported).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Claim/$submit-attachment":{"post":{"tags":["PasAttachment"],"summary":"Submits attachments for a pended prior authorization.","operationId":"pasSubmitAttachment","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The attachment was accepted.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Subscription":{"post":{"tags":["Subscription"],"summary":"Creates a PAS subscription.","operationId":"pasCreateSubscription","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"201":{"description":"The Subscription as stored.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"422":{"description":"Rejected as failing validation against the profile, as naming a member MHK does not hold, or as a Commercial member (not-supported).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}},"get":{"tags":["Subscription"],"summary":"Lists the caller's subscriptions.","operationId":"pasSearchSubscription","parameters":[{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"A searchset Bundle of the caller's Subscriptions.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Subscription/{id}":{"get":{"tags":["Subscription"],"summary":"Reads a subscription.","operationId":"pasReadSubscription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"The Subscription.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}},"put":{"tags":["Subscription"],"summary":"Updates a subscription (endpoint, headers, end, or status off).","operationId":"pasUpdateSubscription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/JsonNode"}},"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"responses":{"200":{"description":"The Subscription as updated.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}},"delete":{"tags":["Subscription"],"summary":"Deletes a subscription.","operationId":"pasDeleteSubscription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted. No body."},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/Subscription/{id}/$status":{"get":{"tags":["Subscription"],"summary":"Subscription $status (backport).","operationId":"pasSubscriptionStatus","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"api-version","in":"query","schema":{"type":"string"}},{"name":"x-api-version","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"A subscription-status notification Bundle.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/FhirResource"}}}},"400":{"description":"Validation failed, or MHK rejected the request on business logic.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"401":{"description":"The bearer token is absent, expired or not valid for this API. Through the gateway the body is an OperationOutcome (issue code login).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"403":{"description":"The token lacks the required scope, or the identifiers do not match the authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"404":{"description":"No such resource or authorization.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"429":{"description":"The gateway rate ceiling was exceeded. Emitted by the gateway as an OperationOutcome (issue code throttled).","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"description":"MHK is throttling, unreachable, or failed. Retryable; see Retry-After. No body."}}}},"/openapi.json":{"get":{"tags":["Conformance"],"summary":"This API's OpenAPI document","operationId":"get-openapi","responses":{"200":{"description":"The OpenAPI 3 document. Anonymous and read-only.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiDocument"}}}}}}}},"components":{"schemas":{"CapabilityStatement":{"required":["resourceType"],"type":"object","properties":{"resourceType":{"enum":["CapabilityStatement"],"type":"string"},"id":{"type":"string"},"status":{"type":"string"},"fhirVersion":{"type":"string"},"rest":{"type":"array","items":{"type":"object"}}},"description":"FHIR R4 CapabilityStatement."},"CdsHookResponse":{"required":["cards"],"type":"object","properties":{"cards":{"type":"array","items":{"type":"object"}},"systemActions":{"type":"array","items":{"type":"object"}}},"description":"CDS Hooks 2.0 response. systemActions carry the CRD coverage-information extension."},"CdsServices":{"type":"object","properties":{"services":{"type":"array","items":{"type":"object","properties":{"hook":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}}},"description":"CDS Hooks discovery response."},"FhirResource":{"required":["resourceType"],"type":"object","properties":{"resourceType":{"type":"string"},"id":{"type":"string"}},"description":"Any FHIR R4 resource. Open beyond resourceType: the facade forwards what the requesting system sent."},"HealthConfigEcho":{"type":"object","properties":{"maxRetries":{"type":"integer","description":"Retries after the first attempt on a PAS call to MHK.","format":"int32"},"perAttemptSeconds":{"type":"number","description":"Timeout for one attempt.","format":"double"},"healthLakeEnabled":{"type":"boolean","description":"Whether `Mhk:HealthLake:BaseUrl` is set, so id-only HealthLake deliveries are read."},"sqsPollerEnabled":{"type":"boolean","description":"Whether the older MHK notification queue poller runs (`Mhk:Subscription:Enabled`)."}},"additionalProperties":false,"description":"The running configuration a dashboard needs to read the other numbers\r\ncorrectly. Non-secret by construction: counts, durations and switches only,\r\nnever a URL, a client id or a key."},"HealthStatus":{"type":"object","properties":{"status":{"type":"string"},"gitSha":{"type":"string"},"buildNumber":{"type":"string"},"builtAt":{"type":"string"},"service":{"$ref":"#/components/schemas/ServiceHealthStatus"},"dependencies":{"$ref":"#/components/schemas/MhkDependencies"},"config":{"$ref":"#/components/schemas/HealthConfigEcho"}},"additionalProperties":false,"description":"Serializes the liveness/build result and its live MHK dependency result."},"JsonNode":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/JsonNodeOptions"},"parent":{"$ref":"#/components/schemas/JsonNode"},"root":{"$ref":"#/components/schemas/JsonNode"}},"additionalProperties":false},"JsonNodeOptions":{"type":"object","properties":{"propertyNameCaseInsensitive":{"type":"boolean"}},"additionalProperties":false},"MhkConnectionResult":{"type":"object","properties":{"status":{"type":"string","description":"Coarse dependency status: healthy or unhealthy."},"checkedAt":{"type":"string","description":"UTC time at which the probe completed.","format":"date-time"},"latencyMs":{"type":"integer","description":"Elapsed milliseconds for an attempted MHK request; null before one starts.","format":"int64","nullable":true},"reason":{"type":"string","description":"Sanitized operational reason; never exception text, response content, or credentials.","nullable":true}},"additionalProperties":false},"MhkDependencies":{"type":"object","properties":{"mhk":{"$ref":"#/components/schemas/MhkConnectionResult"}},"additionalProperties":false,"description":"Contains the sanitized result of the live MHK dependency check."},"OpenApiDocument":{"required":["openapi","paths"],"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object"},"paths":{"type":"object"}},"description":"An OpenAPI 3 document."},"OperationOutcome":{"required":["resourceType","issue"],"type":"object","properties":{"resourceType":{"enum":["OperationOutcome"],"type":"string"},"id":{"type":"string"},"issue":{"type":"array","items":{"required":["severity","code"],"type":"object","properties":{"severity":{"enum":["fatal","error","warning","information"],"type":"string"},"code":{"type":"string"},"diagnostics":{"type":"string"}}}}},"description":"FHIR R4 OperationOutcome. Every error below 500 has this shape."},"Parameters":{"required":["resourceType"],"type":"object","properties":{"resourceType":{"enum":["Parameters"],"type":"string"},"id":{"type":"string"},"parameter":{"type":"array","items":{"type":"object"}}},"description":"FHIR R4 Parameters."},"PasResponseBundle":{"required":["resourceType","type","entry"],"type":"object","properties":{"resourceType":{"enum":["Bundle"],"type":"string"},"type":{"enum":["collection"],"type":"string"},"entry":{"minItems":1,"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string"},"resource":{"$ref":"#/components/schemas/FhirResource"}}}}},"description":"Da Vinci PAS response Bundle (profile-pas-response-bundle). The first entry is the ClaimResponse."},"ServiceHealthStatus":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":false,"description":"Reports the running process as healthy when this handler can execute."},"Subscription":{"required":["resourceType"],"type":"object","properties":{"resourceType":{"enum":["Subscription"],"type":"string"},"id":{"type":"string"},"status":{"enum":["requested","active","error","off"],"type":"string"},"criteria":{"type":"string"},"channel":{"type":"object"}},"description":"FHIR R4 Subscription (Subscriptions Backport 1.1.0) on the PAS topic."}},"securitySchemes":{"Bearer":{"type":"http","description":"Paste a JWT token.","scheme":"Bearer","bearerFormat":"JWT"},"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apim-fmcom-interoppatientaccess-prod-001.azure-api.net/smart-auth/api/token","scopes":{"system/Claim.c":"Submit prior authorization requests (Claim/$submit)","system/Claim.rs":"Read and search prior authorization decisions (Claim/$inquire)"}}}}}},"security":[{"Bearer":[]},{"oauth2":["system/Claim.c","system/Claim.rs"]}],"servers":[{"url":"https://apim-fmcom-interoppatientaccess-prod-001.azure-api.net/prior-auth"}]}