Release 4B 5

This page is part of the FHIR Specification ~~(v4.3.0: R4B~~ (v5.0.0: R5 - STU ). ~~The~~ This is the current published version ~~which supercedes~~ in it's permanent home (it will always be available at this ~~version is 5.0.0 .~~ URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 ~~R4B~~ R5 R4B R4 R3 R2

13.5 Resource EnrollmentResponse - Content

Financial Management icon

Work Group

Maturity Level : 0

Trial Use

Security Category : Patient

Compartments : ~~Not linked to any~~ No defined compartments

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

13.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.

13.5.2 References to this Resource

~~No resources refer to this resource directly.~~

~~This resource implements the~~

Implements: Event ~~pattern.~~

Structure

Name	Flags	Card.	Type	Description & Constraints
EnrollmentResponse	TU		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	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
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 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><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>
</EnrollmentResponse>

JSON Template

{
  "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
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  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

]

Changes ~~since~~ from both R4 and R4B

EnrollmentResponse

EnrollmentResponse.outcome

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

See the Full Difference for further information

This analysis is available for R4 as XML or JSON ~~. Conversions between R3~~ and R4 for R4B as XML or JSON .

See ~~R3 <-->~~ R4 <--> R5 Conversion Maps (status = ~~1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)~~ See Conversions Summary .)

Structure

Name	Flags	Card.	Type	Description & Constraints
EnrollmentResponse	TU		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	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
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 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><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>
</EnrollmentResponse>

JSON Template

{
  "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
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  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

]

Changes ~~since Release 4~~ from both R4 and R4B

EnrollmentResponse

EnrollmentResponse.outcome

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

See the Full Difference for further information

This analysis is available for R4 as XML or JSON ~~. Conversions between R3~~ and R4 for R4B as XML or JSON .

See ~~R3 <-->~~ R4 <--> R5 Conversion Maps (status = ~~1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)~~ See Conversions Summary .)

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

13.5.3.1 Terminology Bindings

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

Path

~~Definition~~ ValueSet

Type

~~Reference~~ Documentation

EnrollmentResponse.status

FinancialResourceStatusCodes

Required

~~FinancialResourceStatusCodes~~

This value set includes Status codes.

EnrollmentResponse.outcome

EnrollmentOutcome (a valid code from Claim Processing Codes )

Required

~~RemittanceOutcome~~

The outcome of the processing.

13.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
identifier	token	The business identifier of the EnrollmentResponse	EnrollmentResponse.identifier
request	reference	The reference to the claim	EnrollmentResponse.request ( EnrollmentRequest )
status	token	The status of the enrollment response	EnrollmentResponse.status