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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringEligibilityResponseThis is a EligibilityResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
insurerReferenceThe Insurer who produced this adjudicated response.
inforcebooleanFlag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurancearray(EligibilityResponse_Insurance)The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
formCodeableConceptThe form to be used for printing the content.
errorarray(EligibilityResponse_Error)Mutually exclusive with Services Provided (Item).

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEligibilityResponseThis is a EligibilityResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
insurerReferenceThe Insurer who produced this adjudicated response.
inforcebooleanFlag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurancearray(EligibilityResponse_Insurance)The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
formCodeableConceptThe form to be used for printing the content.
errorarray(EligibilityResponse_Error)Mutually exclusive with Services Provided (Item).

Response

Read Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
dispositionstring
identifierstring
insurerstring
outcomestring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Response

Search History Eligibility Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
dispositionstring
identifierstring
insurerstring
outcomestring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringEligibilityResponseThis is a EligibilityResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
insurerReferenceThe Insurer who produced this adjudicated response.
inforcebooleanFlag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurancearray(EligibilityResponse_Insurance)The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
formCodeableConceptThe form to be used for printing the content.
errorarray(EligibilityResponse_Error)Mutually exclusive with Services Provided (Item).

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEligibilityResponseThis is a EligibilityResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
insurerReferenceThe Insurer who produced this adjudicated response.
inforcebooleanFlag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
insurancearray(EligibilityResponse_Insurance)The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
formCodeableConceptThe form to be used for printing the content.
errorarray(EligibilityResponse_Error)Mutually exclusive with Services Provided (Item).

Response