v2

Documentation

Index

• func ALRRequest(w http.ResponseWriter, r *http.Request)
• func AttributionStatus(w http.ResponseWriter, r *http.Request)
• func BulkGroupRequest(w http.ResponseWriter, r *http.Request)
• func BulkPatientRequest(w http.ResponseWriter, r *http.Request)
• func DeleteJob(w http.ResponseWriter, r *http.Request)
• func JobStatus(w http.ResponseWriter, r *http.Request)
• func JobsStatus(w http.ResponseWriter, r *http.Request)
• func Metadata(w http.ResponseWriter, r *http.Request)

Functions

func ALRRequest

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

swagger:route GET /api/v1/alr/$export alrData alrRequest

Start FHIR R4 data export for all supported resource types

Initiates a job to collect Assignment List Report data for your ACO. Supported resource types are Patient, Coverage, Group, Risk Assessment, Observation, and Covid Episode.

Produces: - application/fhir+json

Security:

bearer_token:

Responses:

202: BulkRequestResponse
400: badRequestResponse
401: invalidCredentials
429: tooManyRequestsResponse
500: errorResponse

func AttributionStatus

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

swagger:route GET /api/v2/attribution_status attributionStatusV2 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 BulkGroupRequest

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

	swagger:route GET /api/v2/Group/{groupId}/$export bulkDataV2 bulkGroupRequestV2

    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 BulkPatientRequest

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

swagger:route GET /api/v2/Patient/$export bulkDataV2 bulkPatientRequestV2

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 DeleteJob

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

swagger:route DELETE /api/v2/jobs/{jobId} jobV2 deleteJobV2

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 JobStatus

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

swagger:route GET /api/v2/jobs/{jobId} jobV2 jobStatusV2

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 JobsStatus

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

swagger:route GET /api/v2/jobs jobV2 jobsStatusV2

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

func Metadata

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

swagger:route GET /api/v2/metadata metadataV2 metadata

Get metadata

Returns metadata about the API.

Produces: - application/fhir+json

Schemes: http, https

Responses:

200: MetadataResponse