v1

package
v0.0.0-...-065a81b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 30, 2025 License: CC0-1.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ServeData

func ServeData(w http.ResponseWriter, r *http.Request)

swagger:route GET /data/{jobId}/{filename} job serveData

Get data file

Returns the NDJSON file of data generated by an export job. Will be in the format <UUID>.ndjson. Get the full value from the job status response

Produces: - application/fhir+json

Schemes: http, https

Security:

bearer_token:

Responses:

200: FileNDJSON
400: badRequestResponse
401: invalidCredentials
404: notFoundResponse
500: errorResponse

Types

type ApiV1

type ApiV1 struct {
	// contains filtered or unexported fields
}

func NewApiV1

func NewApiV1(db *sql.DB, pool *pgxv5Pool.Pool, provider auth.Provider) *ApiV1

func (ApiV1) AttributionStatus

func (a ApiV1) AttributionStatus(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/v1/attribution_status attributionStatus 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 (ApiV1) BulkGroupRequest

func (a ApiV1) BulkGroupRequest(w http.ResponseWriter, r *http.Request)
	swagger:route GET /api/v1/Group/{groupId}/$export bulkData bulkGroupRequest

    Start FHIR STU3 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 supported Group identifiers 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 (ApiV1) BulkPatientRequest

func (a ApiV1) BulkPatientRequest(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/v1/Patient/$export bulkData bulkPatientRequest

Start FHIR STU3 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 (ApiV1) DeleteJob

func (a ApiV1) DeleteJob(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/v1/jobs/{jobId} job deleteJob

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 (ApiV1) GetAuthInfo

func (a ApiV1) GetAuthInfo(w http.ResponseWriter, r *http.Request)

swagger:route GET /_auth metadata getAuthInfo

Get details about auth

Returns the auth provider that is currently being used. Note that this endpoint is **not** prefixed with the base path (e.g. /api/v1).

Produces: - application/json

Schemes: http, https

Responses:

200: AuthResponse

func (ApiV1) GetVersion

func (a ApiV1) GetVersion(w http.ResponseWriter, r *http.Request)

swagger:route GET /_version metadata getVersion

Get API version

Returns the version of the API that is currently running. Note that this endpoint is **not** prefixed with the base path (e.g. /api/v1).

Produces: - application/json

Schemes: http, https

Responses:

200: VersionResponse

func (ApiV1) HealthCheck

func (a ApiV1) HealthCheck(w http.ResponseWriter, r *http.Request)

func (ApiV1) JobStatus

func (a ApiV1) JobStatus(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/v1/jobs/{jobId} job jobStatus

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 (ApiV1) JobsStatus

func (a ApiV1) JobsStatus(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/v1/jobs job jobsStatus

Get jobs statuses

Returns the current statuses of export jobs. Supported status types are Completed, Archived, Expired, Failed, FailedExpired, Pending, In Progress, 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

func (ApiV1) Metadata

func (a ApiV1) Metadata(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/v1/metadata metadata metadata

Get metadata

Returns metadata about the API.

Produces: - application/fhir+json

Schemes: http, https

Responses:

200: MetadataResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL