{"openapi": "3.0.3", "info": {"title": "DaVinci ATR Consumer", "description": "This Section describes the expected capabilities of the DaVinci ATR Consumer, which is responsible for retrieving and using the Member Attribution List.", "license": {"name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html"}, "version": "2.0.0", "contact": {"email": "fm@lists.HL7.org", "url": "http://www.hl7.org/Special/committees/fm"}}, "externalDocs": {"url": "http://hl7.org/fhir/us/davinci-atr/ImplementationGuide/hl7.fhir.us.davinci-atr", "description": "External Docs Description"}, "paths": {"/atr-consumer/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"}}}}}}}}, "/atr-consumer/Coverage/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "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"]}]}}, "/atr-consumer/Coverage/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Coverage resource with 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"]}]}}, "/atr-consumer/Group": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of the Group 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 Group 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": "identifier", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "characteristic", "in": "query", "required": false, "schema": {"type": "token"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Group.read", "user/Group.read"]}]}}, "/atr-consumer/Group/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a specified Group 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 Group 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/Group.read", "user/Group.read"]}]}}, "/atr-consumer/Group/{rid}/_history/{hid}": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a specified Group 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 Group 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/Group.read", "user/Group.read"]}]}}, "/atr-consumer/Group/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Group resource with 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 Group 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/Group.read", "user/Group.read"]}]}}, "/atr-consumer/Group/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Group 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 Group 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": "identifier", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "characteristic", "in": "query", "required": false, "schema": {"type": "token"}}], "security": [{"smart_on_fhir_oauth2": ["patient/Group.read", "user/Group.read"]}]}}, "/atr-consumer/Location/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a specified Location 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 Location 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/Location.read", "user/Location.read"]}]}}, "/atr-consumer/Location/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Location resource with 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 Location 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/Location.read", "user/Location.read"]}]}}, "/atr-consumer/Organization/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "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"]}]}}, "/atr-consumer/Organization/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Organization resource with 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"]}]}}, "/atr-consumer/Patient/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "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"]}]}}, "/atr-consumer/Patient/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Patient resource with 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"]}]}}, "/atr-consumer/Practitioner/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "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"]}]}}, "/atr-consumer/Practitioner/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the Practitioner resource with 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"]}]}}, "/atr-consumer/PractitionerRole/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a specified PractitionerRole 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 PractitionerRole 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/PractitionerRole.read", "user/PractitionerRole.read"]}]}}, "/atr-consumer/PractitionerRole/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the PractitionerRole resource with 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 PractitionerRole 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/PractitionerRole.read", "user/PractitionerRole.read"]}]}}, "/atr-consumer/RelatedPerson/{rid}": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a specified RelatedPerson 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 RelatedPerson 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/RelatedPerson.read", "user/RelatedPerson.read"]}]}}, "/atr-consumer/RelatedPerson/{rid}/_history": {"get": {"tags": ["DaVinci ATR Consumer"], "description": "Returns a bundle of all versions for the RelatedPerson resource with 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 RelatedPerson 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/RelatedPerson.read", "user/RelatedPerson.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/Group.read": "read a single patient's resources of type Group", "user/Group.read": "read multiple patient's resources of type Group", "patient/Location.read": "read a single patient's resources of type Location", "user/Location.read": "read multiple patient's resources of type Location", "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", "patient/PractitionerRole.read": "read a single patient's resources of type PractitionerRole", "user/PractitionerRole.read": "read multiple patient's resources of type PractitionerRole", "patient/RelatedPerson.read": "read a single patient's resources of type RelatedPerson", "user/RelatedPerson.read": "read multiple patient's resources of type RelatedPerson"}}}}}}}