EnrollmentResponse - FHIR Resource (r4)

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

Validate an EnrollmentResponse FHIR Resource (r4)

EnrollmentResponse Attributes

AttributeField is listTypeDescription

Description: Business Identifier

FHIR Version: r4

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://www.BenefitsInc.com/fhir/enrollmentresponse",
    "value": "781234"
  }
]

Learn more about the (EnrollmentResponse) identifier FHIR attribute

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

FHIR Version: r4

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 (EnrollmentResponse) status FHIR attribute

Description: Claim reference

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"request": {
  "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402"
}

Learn more about the (EnrollmentResponse) request FHIR attribute

Description: queued | complete | error | partial

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"outcome": "complete"

Learn more about the (EnrollmentResponse) outcome FHIR attribute

Description: Disposition Message

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"disposition": "Dependant added to policy."

Learn more about the (EnrollmentResponse) disposition FHIR attribute

Description: Creation date

FHIR Version: r4

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 (EnrollmentResponse) created FHIR attribute

Description: Insurer

FHIR Version: r4

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/2"
}

Learn more about the (EnrollmentResponse) organization FHIR attribute

Description: Responsible practitioner

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (EnrollmentResponse) requestProvider FHIR attribute

EnrollmentResponse Example

{
  "resourceType": "EnrollmentResponse",
  "id": "ER2500",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the EnrollmentResponse</div>"
  },
  "identifier": [
    {
      "system": "http://www.BenefitsInc.com/fhir/enrollmentresponse",
      "value": "781234"
    }
  ],
  "status": "active",
  "request": {
    "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402"
  },
  "outcome": "complete",
  "disposition": "Dependant added to policy.",
  "created": "2014-08-16",
  "organization": {
    "reference": "Organization/2"
  },
  "requestProvider": {
    "reference": "Organization/1"
  }
}

EnrollmentResponse Structure

{
  "resourceType" : "EnrollmentResponse",
  // 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
  "request" : { Reference(EnrollmentRequest) }, // Claim reference
  "outcome" : "<code>", // queued | complete | error | partial
  "disposition" : "<string>", // Disposition Message
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner|PractitionerRole|Organization) } // Responsible practitioner
}

EnrollmentResponse Search Parameters

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

https://api.1up.health/fhir/r4/EnrollmentResponse?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`identifier`	`text`	`identifier`
`request`	`reference`	`request`
`status`	`text`	`status`