{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:patientview/log-in":{"post":{"operationId":"open_data_patientview_log_in","summary":"Log In","description":"POST /auth/login","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:patientview/log-out":{"post":{"operationId":"open_data_patientview_log_out","summary":"Log Out","description":"DELETE /auth/logout/{token}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"token"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-basic-user-information":{"get":{"operationId":"open_data_patientview_get_basic_user_information","summary":"Get Basic User Information","description":"GET /auth/{token}/basicuserinformation","tags":["open-data"],"parameters":[{"name":"token","in":"query","required":true,"description":"token","schema":{"type":"string","description":"token"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-basic-patient-details":{"get":{"operationId":"open_data_patientview_get_basic_patient_details","summary":"Get Basic Patient Information","description":"GET /patient/{userId}/basic","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-patient-management-diagnoses":{"get":{"operationId":"open_data_patientview_get_patient_management_diagnoses","summary":"getPatientManagementDiagnoses","description":"GET /patientmanagement/diagnoses","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-patient-management-lookup-types":{"get":{"operationId":"open_data_patientview_get_patient_management_lookup_types","summary":"getPatientManagementLookupTypes","description":"GET /patientmanagement/lookuptypes","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/validate-patient-management":{"post":{"operationId":"open_data_patientview_validate_patient_management","summary":"validatePatientManagement","description":"POST /patientmanagement/validate","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-patient-management":{"get":{"operationId":"open_data_patientview_get_patient_management","summary":"getPatientManagement","description":"GET /patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}},{"name":"groupId","in":"query","required":true,"description":"groupId","schema":{"type":"integer","description":"groupId"}},{"name":"identifierId","in":"query","required":true,"description":"identifierId","schema":{"type":"integer","description":"identifierId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/save-patient-management":{"post":{"operationId":"open_data_patientview_save_patient_management","summary":"savePatientManagement","description":"POST /patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","groupId","identifierId"],"properties":{"userId":{"type":"integer","description":"userId"},"groupId":{"type":"integer","description":"groupId"},"identifierId":{"type":"integer","description":"identifierId"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:patientview/save-patient-management-surgeries":{"post":{"operationId":"open_data_patientview_save_patient_management_surgeries","summary":"savePatientManagementSurgeries","description":"POST /patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}/surgeries","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","groupId","identifierId"],"properties":{"userId":{"type":"integer","description":"userId"},"groupId":{"type":"integer","description":"groupId"},"identifierId":{"type":"integer","description":"identifierId"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-available-observation-headings":{"get":{"operationId":"open_data_patientview_get_available_observation_headings","summary":"Get Available Observations Types For a User","description":"GET /user/{userId}/availableobservationheadings","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-observations-by-codes":{"get":{"operationId":"open_data_patientview_get_observations_by_codes","summary":"Get Observations of Multiple Types For a User","description":"GET /user/{userId}/observations","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}},{"name":"code","in":"query","required":true,"description":"code","schema":{"type":"array","description":"code"}},{"name":"limit","in":"query","required":true,"description":"limit","schema":{"type":"integer","description":"limit"}},{"name":"offset","in":"query","required":true,"description":"offset","schema":{"type":"integer","description":"offset"}},{"name":"orderDirection","in":"query","required":true,"description":"orderDirection","schema":{"type":"string","description":"orderDirection"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-observations-by-code":{"get":{"operationId":"open_data_patientview_get_observations_by_code","summary":"Get Observations of a Certain Type For a User","description":"GET /user/{userId}/observations/{code}","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}},{"name":"code","in":"query","required":true,"description":"code","schema":{"type":"string","description":"code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-patient-entered-observations-by-code":{"get":{"operationId":"open_data_patientview_get_patient_entered_observations_by_code","summary":"Get patient entered Observations of a Certain Type For a User","description":"GET /user/{userId}/observations/{code}/patiententered","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}},{"name":"code","in":"query","required":true,"description":"code","schema":{"type":"string","description":"code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:patientview/get-patient-entered-observation-headings":{"get":{"operationId":"open_data_patientview_get_patient_entered_observation_headings","summary":"Get Available Patient Entered Observations Types For a User","description":"GET /user/{userId}/patiententeredobservationheadings","tags":["open-data"],"parameters":[{"name":"userId","in":"query","required":true,"description":"userId","schema":{"type":"integer","description":"userId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}