DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

7.8 Resource EnrollmentResponse - Content

This resource is marked as a draft.

This resource maintained by the Financial Management Work Group

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

7.8.1 Scope and Usage

This resource has not yet undergone proper review by FM. At this time, it is to be considered as a draft.

The EnrollmentResponse resource provides enrollment and plan details from the processing of an Enrollment resource. It combines key information from a payor as to whether a Coverage or Policy is in-force, and optionally the nature of the Policy details.

Todo

7.8.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentResponse DomainResourceEnrollmentResponse resource
... identifier 0..*IdentifierBusiness Identifier
... request 0..1EnrollmentRequestClaim reference
... outcome 0..1codecomplete | error
RemittanceOutcome (Required)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... organization 0..1OrganizationInsurer
... requestProvider 0..1PractitionerResponsible practitioner
... requestOrganization 0..1OrganizationResponsible organization

XML Template

<EnrollmentResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(EnrollmentRequest) Claim reference --></request>
 <outcome value="[code]"/><!-- 0..1 complete | error -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
</EnrollmentResponse>

JSON Template

{doco
  "resourceType" : "EnrollmentResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(EnrollmentRequest) }, // Claim reference
  "outcome" : "<code>", // complete | error
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) } // Responsible organization
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentResponse DomainResourceEnrollmentResponse resource
... identifier 0..*IdentifierBusiness Identifier
... request 0..1EnrollmentRequestClaim reference
... outcome 0..1codecomplete | error
RemittanceOutcome (Required)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... organization 0..1OrganizationInsurer
... requestProvider 0..1PractitionerResponsible practitioner
... requestOrganization 0..1OrganizationResponsible organization

XML Template

<EnrollmentResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(EnrollmentRequest) Claim reference --></request>
 <outcome value="[code]"/><!-- 0..1 complete | error -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
</EnrollmentResponse>

JSON Template

{doco
  "resourceType" : "EnrollmentResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(EnrollmentRequest) }, // Claim reference
  "outcome" : "<code>", // complete | error
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) } // Responsible organization
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)

7.8.2.1 Terminology Bindings

PathDefinitionTypeReference
EnrollmentResponse.outcome The outcome of the processing.Requiredhttp://hl7.org/fhir/RS-link
EnrollmentResponse.ruleset
EnrollmentResponse.originalRuleset 		The static and dynamic model to which contents conform, may be business version or standard and version.Examplehttp://hl7.org/fhir/vs/ruleset

7.8.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
identifiertokenThe business identifier of the Explanation of BenefitEnrollmentResponse.identifier