{"openapi": "3.0.3", "info": {"title": "Carin Blue Button Capability Statement", "description": "This Section describes the expected capabilities of the C4BB Server actor which is responsible for providing responses to the queries submitted by the C4BB Requestors. \n\nThe EOB Resource is the focal Consumer-Directed Payer Data Exchange (CDPDE) Resource. Several Reference Resources are defined directly/indirectly from the EOB: Coverage, Patient, Organization (Payer ID), Practioner, and Organization (Facility).\n\nThe Coverage Reference Resource SHALL be returned with data that was effective as of the date of service of the claim; for example, the data will reflect the employer name in effect at that time. However, for other reference resources, payers MAY decide to provide either the data that was in effect as of the date of service or the current data. All reference resources within the EOB will have meta.lastUpdated flagged as must support. Payers SHALL provide the last time the data was updated or the date of creation in the payers system of record, whichever comes last. Apps will use the meta.lastUpdated values to determine if the reference resources are as of the current date or date of service.", "license": {"name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html"}, "version": "1.1.0", "contact": {"email": "fm@lists.HL7.org", "url": "http://www.hl7.org/Special/committees/fm/index.cfm"}}, "externalDocs": {"url": "http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb", "description": "External Docs Description"}, "paths": {"/carin-bb/metadata": {"summary": "Access to the Server's Capability Statement", "description": "All FHIR Servers return a CapabilityStatement that describes what services they perform", "get": {"tags": ["Metadata"], "summary": "Return the server's capability statement", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "the capbility statement", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CapabilityStatement"}}}}}}}}, "/carin-bb/Coverage/{rid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Coverage resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Coverage with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Coverage.read", "user/Coverage.read"]}]}}, "/carin-bb/Coverage": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a bundle of the Coverage resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Coverage with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [], "security": [{"smart_on_fhir_oauth2": ["patient/Coverage.read", "user/Coverage.read"]}]}}, "/carin-bb/ExplanationOfBenefit": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a bundle of the ExplanationOfBenefit resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A ExplanationOfBenefit with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "patient", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "identifier", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "service-date", "in": "query", "required": false, "schema": {"type": "date"}}], "security": [{"smart_on_fhir_oauth2": ["patient/ExplanationOfBenefit.read", "user/ExplanationOfBenefit.read"]}]}}, "/carin-bb/ExplanationOfBenefit/{rid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified ExplanationOfBenefit resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A ExplanationOfBenefit with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/ExplanationOfBenefit.read", "user/ExplanationOfBenefit.read"]}]}}, "/carin-bb/Organization/{rid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Organization resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Organization with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Organization.read", "user/Organization.read"]}]}}, "/carin-bb/Organization/{rid}/_history/{hid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Organization resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Organization with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Organization.read", "user/Organization.read"]}]}}, "/carin-bb/Organization": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a bundle of the Organization resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Organization with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [], "security": [{"smart_on_fhir_oauth2": ["patient/Organization.read", "user/Organization.read"]}]}}, "/carin-bb/Patient/{rid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Patient resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Patient with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Patient.read", "user/Patient.read"]}]}}, "/carin-bb/Patient/{rid}/_history/{hid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Patient resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Patient with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Patient.read", "user/Patient.read"]}]}}, "/carin-bb/Patient": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a bundle of the Patient resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Patient with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [], "security": [{"smart_on_fhir_oauth2": ["patient/Patient.read", "user/Patient.read"]}]}}, "/carin-bb/Practitioner/{rid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Practitioner resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Practitioner with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Practitioner.read", "user/Practitioner.read"]}]}}, "/carin-bb/Practitioner/{rid}/_history/{hid}": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a specified Practitioner resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Practitioner with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Practitioner.read", "user/Practitioner.read"]}]}}, "/carin-bb/Practitioner": {"get": {"tags": ["Carin Blue Button Endpoints"], "description": "Returns a bundle of the Practitioner resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Practitioner with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [], "security": [{"smart_on_fhir_oauth2": ["patient/Practitioner.read", "user/Practitioner.read"]}]}}}, "components": {"securitySchemes": {"smart_on_fhir_oauth2": {"type": "oauth2", "description": "Smart on FHIR implementation of OAuth2", "flows": {"authorizationCode": {"authorizationUrl": "http://onyx-slap-onyx-slap-v3.onyx-slap-ks-stg.svc.cluster.local.:8000//authorize?aud=http://fite.ks-stg.gw02.abacusinsights.ai/v1/api", "tokenUrl": "http://onyx-slap-onyx-slap-v3.onyx-slap-ks-stg.svc.cluster.local.:8000//token", "refreshUrl": "http://onyx-slap-onyx-slap-v3.onyx-slap-ks-stg.svc.cluster.local.:8000//refresh", "scopes": {"openid": "Permission to retrieve information about the current logged-in user", "fhirUser": "FHIR id of the logged in user", "launch/patient": "When launching outside the EHR, ask for a patient to be selected at launch time", "offline_access": "Request a refresh_token that can be used to obtain a new access token to replace an expired one, even after the end-user no long is online after the access token rexpire", "patient/Coverage.read": "read a single patient's resources of type Coverage", "user/Coverage.read": "read multiple patient's resources of type Coverage", "patient/ExplanationOfBenefit.read": "read a single patient's resources of type ExplanationOfBenefit", "user/ExplanationOfBenefit.read": "read multiple patient's resources of type ExplanationOfBenefit", "patient/Organization.read": "read a single patient's resources of type Organization", "user/Organization.read": "read multiple patient's resources of type Organization", "patient/Patient.read": "read a single patient's resources of type Patient", "user/Patient.read": "read multiple patient's resources of type Patient", "patient/Practitioner.read": "read a single patient's resources of type Practitioner", "user/Practitioner.read": "read multiple patient's resources of type Practitioner"}}}}}}}