FHIR ~~Release 3 (STU)~~ CI-Build

This ~~page~~ is ~~part of~~ the ~~FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list~~ Continuous Integration Build of ~~available versions, see~~ FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon ~~. Page versions: R5 R4B R4 R3 R2~~

13.5 16.5 Resource EnrollmentResponse - Content

Responsible Owner: Financial Management icon

Work Group

Normative ~~Maturity Level : 0~~

~~Draft~~ Security Category : Patient

Compartments : ~~Not linked to any defined compartments~~ Group , Patient

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

13.5.1 16.5.1 Scope and Usage

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

The EnrollmentResponse resource provides enrollment and plan details from the processing of an Enrollment resource.

16.5.2 References to this Resource

Implements: Event

Structure

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
EnrollmentResponse	N		DomainResource	EnrollmentResponse resource Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier		0..*	Identifier	Business Identifier
status	?! Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Binding: Financial Resource Status Codes ( Required )
request		0..1	Reference ( EnrollmentRequest )	Claim reference
outcome		0..1	~~CodeableConcept~~ code	queued \| complete \| error \| partial ~~RemittanceOutcome~~ Binding: Enrollment Outcome ( Required )
disposition		0..1	string	Disposition Message
created		0..1	dateTime	Creation date
organization		0..1	Reference ( Organization )	Insurer
requestProvider		0..1	Reference ( Practitioner \| PractitionerRole \| Organization )	Responsible practitioner
~~requestOrganization~~ candidate		0..1	Reference ( ~~Organization~~ Patient \| Group )	The subject(s)to be enrolled ~~Responsible organization~~
Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

XML Template

<

<EnrollmentResponse xmlns="http://hl7.org/fhir"> 

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->

 <request><!-- 0..1 Reference(EnrollmentRequest) Claim reference --></request>
 <</outcome>
 <
 <

 <outcome value="[code]"/><!-- 0..1 queued | complete | error | partial -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->

 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <</requestProvider>
 <</requestOrganization>

 <requestProvider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>
 <candidate><!-- 0..1 Reference(Group|Patient) The subject(s)to be enrolled --></candidate>

</EnrollmentResponse>

JSON Template

{
  "resourceType" : "",

  "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(Organization|Practitioner|PractitionerRole) }, // Responsible practitioner
  "candidate" : { Reference(Group|Patient) } // The subject(s)to be enrolled

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:;

[ a fhir:EnrollmentResponse;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier
  fhir:status [ code ] ; # 0..1 active | cancelled | draft | entered-in-error
  fhir:request [ Reference(EnrollmentRequest) ] ; # 0..1 Claim reference
  fhir:outcome [ code ] ; # 0..1 queued | complete | error | partial
  fhir:disposition [ string ] ; # 0..1 Disposition Message
  fhir:created [ dateTime ] ; # 0..1 Creation date
  fhir:organization [ Reference(Organization) ] ; # 0..1 Insurer
  fhir:requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Responsible practitioner
  fhir:candidate [ Reference(Group|Patient) ] ; # 0..1 The subject(s)to be enrolled

]

Changes ~~since DSTU2~~ from R5 to R6

EnrollmentResponse

~~EnrollmentResponse.status~~ EnrollmentResponse.candidate

Added Element

Changes from R4B to R6

EnrollmentResponse

EnrollmentResponse.outcome

~~Type changed~~ Change value set from ~~code~~ http://hl7.org/fhir/ValueSet/remittance-outcome|4.3.0 to ~~CodeableConcept~~ Enrollment Outcome

~~EnrollmentResponse.ruleset~~ EnrollmentResponse.candidate

~~deleted~~ Added Element

Changes from R4 to R6

~~EnrollmentResponse.originalRuleset~~ EnrollmentResponse

EnrollmentResponse.outcome

~~deleted~~ Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to Enrollment Outcome

EnrollmentResponse.candidate

Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON ~~. See R2 <--> R3 Conversion Maps~~ ~~(status = 1 test that all execute ok. 1 fail round-trip testing~~ and ~~all r3 resources are valid.).~~ for R4B as XML or JSON .

Structure

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
EnrollmentResponse	N		DomainResource	EnrollmentResponse resource Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier		0..*	Identifier	Business Identifier
status	?! Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Binding: Financial Resource Status Codes ( Required )
request		0..1	Reference ( EnrollmentRequest )	Claim reference
outcome		0..1	~~CodeableConcept~~ code	queued \| complete \| error \| partial ~~RemittanceOutcome~~ Binding: Enrollment Outcome ( Required )
disposition		0..1	string	Disposition Message
created		0..1	dateTime	Creation date
organization		0..1	Reference ( Organization )	Insurer
requestProvider		0..1	Reference ( Practitioner \| PractitionerRole \| Organization )	Responsible practitioner
~~requestOrganization~~ candidate		0..1	Reference ( ~~Organization~~ Patient \| Group )	The subject(s)to be enrolled ~~Responsible organization~~
Documentation for this format

See the Extensions for this resource

UML Diagram ( Legend )

XML Template

<

<EnrollmentResponse xmlns="http://hl7.org/fhir"> 

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->

 <request><!-- 0..1 Reference(EnrollmentRequest) Claim reference --></request>
 <</outcome>
 <
 <

 <outcome value="[code]"/><!-- 0..1 queued | complete | error | partial -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->

 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <</requestProvider>
 <</requestOrganization>

 <requestProvider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>
 <candidate><!-- 0..1 Reference(Group|Patient) The subject(s)to be enrolled --></candidate>

</EnrollmentResponse>

JSON Template

{
  "resourceType" : "",

  "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(Organization|Practitioner|PractitionerRole) }, // Responsible practitioner
  "candidate" : { Reference(Group|Patient) } // The subject(s)to be enrolled

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:;

[ a fhir:EnrollmentResponse;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier
  fhir:status [ code ] ; # 0..1 active | cancelled | draft | entered-in-error
  fhir:request [ Reference(EnrollmentRequest) ] ; # 0..1 Claim reference
  fhir:outcome [ code ] ; # 0..1 queued | complete | error | partial
  fhir:disposition [ string ] ; # 0..1 Disposition Message
  fhir:created [ dateTime ] ; # 0..1 Creation date
  fhir:organization [ Reference(Organization) ] ; # 0..1 Insurer
  fhir:requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Responsible practitioner
  fhir:candidate [ Reference(Group|Patient) ] ; # 0..1 The subject(s)to be enrolled

]

Changes ~~since DSTU2~~ from R5 to R6

EnrollmentResponse

~~EnrollmentResponse.status~~ EnrollmentResponse.candidate

Added Element

Changes from R4B to R6

EnrollmentResponse

EnrollmentResponse.outcome

~~Type changed~~ Change value set from ~~code~~ http://hl7.org/fhir/ValueSet/remittance-outcome|4.3.0 to ~~CodeableConcept~~ Enrollment Outcome

~~EnrollmentResponse.ruleset~~ EnrollmentResponse.candidate

~~deleted~~ Added Element

Changes from R4 to R6

~~EnrollmentResponse.originalRuleset~~ EnrollmentResponse

EnrollmentResponse.outcome

~~deleted~~ Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to Enrollment Outcome

EnrollmentResponse.candidate

Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON ~~. See R2 <--> R3 Conversion Maps~~ ~~(status = 1 test that all execute ok. 1 fail round-trip testing~~ and ~~all r3 resources are valid.).~~ for R4B as XML or JSON .

~~Alternate~~ Additional definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron ~~(for )~~ + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

13.5.2.1 16.5.3.1 Terminology Bindings

Path	~~Definition~~ ValueSet	Type	~~Reference~~ Documentation
EnrollmentResponse.status	~~A code specifying the state of the resource instance.~~ FinancialResourceStatusCodes	Required	~~Financial Resource~~ This value set includes Status ~~Codes~~ codes.
EnrollmentResponse.outcome	~~The outcome of the processing.~~ EnrollmentOutcome (a valid code from Claim Processing Codes )	Required	~~RemittanceOutcome~~ The outcome of the processing.

Path

~~Definition~~ ValueSet

Type

~~Reference~~ Documentation

EnrollmentResponse.status

~~A code specifying the state of the resource instance.~~ FinancialResourceStatusCodes

Required

~~Financial Resource~~

This value set includes Status ~~Codes~~ codes.

EnrollmentResponse.outcome

~~The outcome of the processing.~~ EnrollmentOutcome (a valid code from Claim Processing Codes )

Required

~~RemittanceOutcome~~

The outcome of the processing.

13.5.3 16.5.4 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
group	reference	The parties to be enrolled	EnrollmentResponse.candidate.where(resolve() is Group) ( Group )
identifier	token	The business identifier of the EnrollmentResponse	EnrollmentResponse.identifier
~~organization~~ patient	reference	The ~~organization who generated this resource~~ party to be enrolled	~~EnrollmentResponse.organization~~ EnrollmentResponse.candidate.where(resolve() is Patient) ( ~~Organization~~ Patient )
request	reference	The reference to the claim	EnrollmentResponse.request ( EnrollmentRequest )
status	token	The status of the enrollment response	EnrollmentResponse.status