EligibilityRequest - FHIR Resource (stu3)

This EligibilityRequest Resource uses the FHIR API standard for access and structure.

Validate an EligibilityRequest FHIR Resource (stu3)

EligibilityRequest Attributes

AttributeField is listTypeDescription

Description: active | cancelled | draft | entered-in-error

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "active"

Learn more about the (EligibilityRequest) status FHIR attribute

Description: Business agreement

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"businessArrangement":

Learn more about the (EligibilityRequest) businessArrangement FHIR attribute

Description: Business Identifier

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://happyvalley.com/elegibilityrequest",
    "value": "52345"
  }
]

Learn more about the (EligibilityRequest) identifier FHIR attribute

Description: The subject of the Products and Services

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"patient": {
  "reference": "Patient/pat1"
}

Learn more about the (EligibilityRequest) patient FHIR attribute

Description: Target

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"insurer": {
  "reference": "Organization/2"
}

Learn more about the (EligibilityRequest) insurer FHIR attribute

Description: Creation date

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"created": "2014-08-16"

Learn more about the (EligibilityRequest) created FHIR attribute

Description: Author

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"enterer":

Learn more about the (EligibilityRequest) enterer FHIR attribute

Description: Detailed services covered within the type

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"benefitSubCategory":

Learn more about the (EligibilityRequest) benefitSubCategory FHIR attribute

Description: Desired processing priority

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"priority": {
  "coding": [
    {
      "code": "normal"
    }
  ]
}

Learn more about the (EligibilityRequest) priority FHIR attribute

Description: "servicedPeriod" : { Period },

FHIR Version: stu3

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"servicedPeriod":

Learn more about the (EligibilityRequest) servicedPeriod FHIR attribute

Description: Servicing Facility

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"facility":

Learn more about the (EligibilityRequest) facility FHIR attribute

Description: Insurance or medical plan

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"coverage": {
  "reference": "Coverage/9876B1"
}

Learn more about the (EligibilityRequest) coverage FHIR attribute

Description: Responsible practitioner

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"provider":

Learn more about the (EligibilityRequest) provider FHIR attribute

Description: Responsible organization

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"organization": {
  "reference": "Organization/1"
}

Learn more about the (EligibilityRequest) organization FHIR attribute

Description: "servicedDate" : "<date>",

FHIR Version: stu3

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"servicedDate":

Learn more about the (EligibilityRequest) servicedDate FHIR attribute

Description: Type of services covered

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"benefitCategory":

Learn more about the (EligibilityRequest) benefitCategory FHIR attribute

EligibilityRequest Example

{
  "status": "active",
  "patient": {
    "reference": "Patient/pat1"
  },
  "created": "2014-08-16",
  "resourceType": "EligibilityRequest",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the EligibilityRequest</div>"
  },
  "insurer": {
    "reference": "Organization/2"
  },
  "priority": {
    "coding": [
      {
        "code": "normal"
      }
    ]
  },
  "coverage": {
    "reference": "Coverage/9876B1"
  },
  "organization": {
    "reference": "Organization/1"
  },
  "identifier": [
    {
      "system": "http://happyvalley.com/elegibilityrequest",
      "value": "52345"
    }
  ],
  "id": "52345"
}

EligibilityRequest Structure


  
{
  "resourceType" : "EligibilityRequest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // active | cancelled | draft | entered-in-error
  "priority" : { CodeableConcept }, // Desired processing priority
  "patient" : { Reference(Patient) }, // The subject of the Products and Services
  // serviced[x]: Estimated date or dates of Service. One of these 2:
  "servicedDate" : "<date>",
  "servicedPeriod" : { Period },
  "created" : "<dateTime>", // Creation date
  "enterer" : { Reference(Practitioner) }, // Author
  "provider" : { Reference(Practitioner) }, // Responsible practitioner
  "organization" : { Reference(Organization) }, // Responsible organization
  "insurer" : { Reference(Organization) }, // Target
  "facility" : { Reference(Location) }, // Servicing Facility
  "coverage" : { Reference(Coverage) }, // Insurance or medical plan
  "businessArrangement" : "<string>", // Business agreement
  "benefitCategory" : { CodeableConcept }, // Type of services covered
  "benefitSubCategory" : { CodeableConcept } // Detailed services covered within the type
}

EligibilityRequest Search Parameters

The following search parameters can be used to query EligibilityRequest resources. Just submit them like so:

https://api.1up.health/fhir/stu3/EligibilityRequest?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`created`	`date`	`created`
`enterer`	`reference`	`enterer`
`facility`	`reference`	`facility`
`identifier`	`text`	`identifier`
`organization`	`reference`	`organization`
`patient`	`reference`	`patient`
`provider`	`reference`	`provider`