EligibilityRequest - FHIR Resource (stu3)
This EligibilityRequest Resource uses the
FHIR API standard for access and structure.
Validate an EligibilityRequest FHIR Resource (stu3)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
benefitCategory | false | CodeableConcept | # Type of services covered
|
benefitSubCategory | false | CodeableConcept | # Detailed services covered within the type
|
businessArrangement | false | string | # Business agreement
|
coverage | false | Reference | # Insurance or medical plan
|
created | false | dateTime | # Creation date
|
enterer | false | Reference | # Author
|
facility | false | Reference | # Servicing Facility
|
identifier | true | Identifier | # Business Identifier
|
insurer | false | Reference | # Target
|
organization | false | Reference | # Responsible organization
|
patient | false | Reference | # The subject of the Products and Services
|
priority | false | CodeableConcept | # Desired processing priority
|
provider | false | Reference | # Responsible practitioner
|
servicedDate | false | date | # "servicedDate" : "<date>",
|
servicedPeriod | false | Period | # "servicedPeriod" : { Period },
|
status | false | code | # active | cancelled | draft | entered-in-error
|
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 |