eligibility responses

Create Eligibility Response

post

/organizations/{organizationId}/fhir/3/EligibilityResponse

This resource provides eligibility and plan details from the processing of an Eligibility resource.

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	EligibilityResponse	This is a EligibilityResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete.
disposition	string		A description of the status of the adjudication.
insurer	Reference		The Insurer who produced this adjudicated response.
inforce	boolean		Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurance	array(EligibilityResponse_Insurance)		The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
form	CodeableConcept		The form to be used for printing the content.
error	array(EligibilityResponse_Error)		Mutually exclusive with Services Provided (Item).

Response

200 400 401 404

Patch Eligibility Response

patch

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}

This resource provides eligibility and plan details from the processing of an Eligibility resource.

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	EligibilityResponse	This is a EligibilityResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete.
disposition	string		A description of the status of the adjudication.
insurer	Reference		The Insurer who produced this adjudicated response.
inforce	boolean		Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurance	array(EligibilityResponse_Insurance)		The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
form	CodeableConcept		The form to be used for printing the content.
error	array(EligibilityResponse_Error)		Mutually exclusive with Services Provided (Item).

Response

200 400 401 404 409

Read Eligibility Response

get

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Eligibility Response

get

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Eligibility Response

get

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Eligibility Response

delete

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404 409

Search Get Eligibility Response

get

/organizations/{organizationId}/fhir/3/EligibilityResponse

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
created	string
disposition	string
identifier	string
insurer	string
outcome	string
request	string
request-organization	string
request-provider	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Eligibility Response

get

/organizations/{organizationId}/fhir/3/EligibilityResponse/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Eligibility Response

post

/organizations/{organizationId}/fhir/3/EligibilityResponse/_search

This resource provides eligibility and plan details from the processing of an Eligibility resource.

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
created	string
disposition	string
identifier	string
insurer	string
outcome	string
request	string
request-organization	string
request-provider	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	EligibilityResponse	This is a EligibilityResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete.
disposition	string		A description of the status of the adjudication.
insurer	Reference		The Insurer who produced this adjudicated response.
inforce	boolean		Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurance	array(EligibilityResponse_Insurance)		The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
form	CodeableConcept		The form to be used for printing the content.
error	array(EligibilityResponse_Error)		Mutually exclusive with Services Provided (Item).

Response

200 401 404

Update Eligibility Response

put

/organizations/{organizationId}/fhir/3/EligibilityResponse/{resourceId}

This resource provides eligibility and plan details from the processing of an Eligibility resource.

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	EligibilityResponse	This is a EligibilityResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete.
disposition	string		A description of the status of the adjudication.
insurer	Reference		The Insurer who produced this adjudicated response.
inforce	boolean		Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurance	array(EligibilityResponse_Insurance)		The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
form	CodeableConcept		The form to be used for printing the content.
error	array(EligibilityResponse_Error)		Mutually exclusive with Services Provided (Item).

Response

200 400 401 404 409