Documentation
¶
Index ¶
- type ApiV3
- func (a ApiV3) AttributionStatus(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) BulkGroupRequest(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) BulkPatientRequest(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) DeleteJob(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) JobStatus(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) JobsStatus(w http.ResponseWriter, r *http.Request)
- func (a ApiV3) Metadata(w http.ResponseWriter, r *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiV3 ¶
type ApiV3 struct {
// contains filtered or unexported fields
}
func (ApiV3) AttributionStatus ¶
func (a ApiV3) AttributionStatus(w http.ResponseWriter, r *http.Request)
swagger:route GET /api/v3/attribution_status attributionStatusv3 attributionStatus
Get attribution status ¶
Returns the status of the latest ingestion for attribution and claims runout files. The response will contain the Type to identify which ingestion and a Timestamp for the last time it was updated.
Produces: - application/json
Schemes: http, https
Security:
bearer_token:
Responses:
200: AttributionFileStatusResponse 404: notFoundResponse
func (ApiV3) BulkGroupRequest ¶
func (a ApiV3) BulkGroupRequest(w http.ResponseWriter, r *http.Request)
swagger:route GET /api/v3/Group/{groupId}/$export bulkDatav3 bulkGroupRequestv3
Start FHIR R4 data export (for the specified group identifier) for all supported resource types
Initiates a job to collect data from the Blue Button API for your ACO. The only Group identifier supported by the system are `all` and `runout`.
The `all` identifier returns data for the group of all patients attributed to the requesting ACO. If used when specifying `_since`: all claims data which has been updated since the specified date will be returned for beneficiaries which have been attributed to the ACO since before the specified date; and all historical claims data will be returned for beneficiaries which have been newly attributed to the ACO since the specified date.
The `runout` identifier returns claims runouts data.
Produces:
- application/fhir+json
Security:
bearer_token:
Responses:
202: BulkRequestResponse
400: badRequestResponse
401: invalidCredentials
429: tooManyRequestsResponse
500: errorResponse
func (ApiV3) BulkPatientRequest ¶
func (a ApiV3) BulkPatientRequest(w http.ResponseWriter, r *http.Request)
swagger:route GET /api/v3/Patient/$export bulkDatav3 bulkPatientRequestv3
Start FHIR R4 data export for all supported resource types.
Initiates a job to collect data from the Blue Button API for your ACO. Supported resource types are Patient, Coverage, and ExplanationOfBenefit.
Produces: - application/fhir+json
Security:
bearer_token:
Responses:
202: BulkRequestResponse 400: badRequestResponse 401: invalidCredentials 429: tooManyRequestsResponse 500: errorResponse
func (ApiV3) DeleteJob ¶
func (a ApiV3) DeleteJob(w http.ResponseWriter, r *http.Request)
swagger:route DELETE /api/v3/jobs/{jobId} jobv3 deleteJobv3
Cancel a job ¶
Cancels a currently running job.
Produces: - application/fhir+json
Schemes: http, https
Security:
bearer_token:
Responses:
202: deleteJobResponse 400: badRequestResponse 401: invalidCredentials 404: notFoundResponse 410: goneResponse 500: errorResponse
func (ApiV3) JobStatus ¶
func (a ApiV3) JobStatus(w http.ResponseWriter, r *http.Request)
swagger:route GET /api/v3/jobs/{jobId} jobv3 jobStatusv3
Get job status ¶
Returns the current status of an export job.
Produces: - application/fhir+json
Schemes: http, https
Security:
bearer_token:
Responses:
202: jobStatusResponse 200: completedJobResponse 400: badRequestResponse 401: invalidCredentials 404: notFoundResponse 410: goneResponse 500: errorResponse
func (ApiV3) JobsStatus ¶
func (a ApiV3) JobsStatus(w http.ResponseWriter, r *http.Request)
swagger:route GET /api/v3/jobs jobv3 jobsStatusv3
Get jobs statuses ¶
Returns the current statuses of export jobs. Supported status types are Completed, Archived, Expired, Failed, FailedExpired, In Progress, Pending, Cancelled, and CancelledExpired. If no status(s) is provided, all jobs will be returned.
Note on job status to fhir task resource status mapping: Due to the fhir task status field having a smaller set of values, the following statuses will be set to different fhir values in the response
Archived, Expired -> Completed FailedExpired -> Failed Pending -> In Progress CancelledExpired -> Cancelled
Though the status name has been remapped the response will still only contain jobs pertaining to the provided job status in the request.
Produces: - application/fhir+json
Schemes: http, https
Security:
bearer_token:
Responses:
200: jobsStatusResponse 400: badRequestResponse 401: invalidCredentials 404: notFoundResponse 410: goneResponse 500: errorResponse