Release 4
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

13.5 Resource EnrollmentResponse - Content

Financial Management Work Group Maturity Level : 0   Trial Use Security Category : Patient Compartments : Not linked to any defined compartments

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

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.

No resources refer to this resource directly.

This resource implements the Event pattern.

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

 <requestProvider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>

</EnrollmentResponse>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ 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:EnrollmentResponse.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:EnrollmentResponse.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:EnrollmentResponse.request [ Reference(EnrollmentRequest) ]; # 0..1 Claim reference
  fhir:EnrollmentResponse.outcome [ code ]; # 0..1 queued | complete | error | partial
  fhir:EnrollmentResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:EnrollmentResponse.created [ dateTime ]; # 0..1 Creation date
  fhir:EnrollmentResponse.organization [ Reference(Organization) ]; # 0..1 Insurer
  fhir:

  fhir:EnrollmentResponse.requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Responsible practitioner

]

Changes since R3

EnrollmentResponse
EnrollmentResponse.status
  • Change value set from http://hl7.org/fhir/ValueSet/fm-status http://hl7.org/fhir/ValueSet/fm-status|4.0.0 to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 http://hl7.org/fhir/ValueSet/fm-status|4.2.0
EnrollmentResponse.outcome
  • Type changed from CodeableConcept to code Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 EnrollmentResponse.requestProvider Type Reference: Added Target Types PractitionerRole, Organization EnrollmentResponse.requestOrganization deleted http://hl7.org/fhir/ValueSet/remittance-outcome|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

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

 <requestProvider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></requestProvider>

</EnrollmentResponse>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ 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:EnrollmentResponse.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:EnrollmentResponse.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:EnrollmentResponse.request [ Reference(EnrollmentRequest) ]; # 0..1 Claim reference
  fhir:EnrollmentResponse.outcome [ code ]; # 0..1 queued | complete | error | partial
  fhir:EnrollmentResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:EnrollmentResponse.created [ dateTime ]; # 0..1 Creation date
  fhir:EnrollmentResponse.organization [ Reference(Organization) ]; # 0..1 Insurer
  fhir:

  fhir:EnrollmentResponse.requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Responsible practitioner

]

Changes since Release 3

EnrollmentResponse
EnrollmentResponse.status
  • Change value set from http://hl7.org/fhir/ValueSet/fm-status http://hl7.org/fhir/ValueSet/fm-status|4.0.0 to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 http://hl7.org/fhir/ValueSet/fm-status|4.2.0
EnrollmentResponse.outcome
  • Type changed from CodeableConcept to code Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 EnrollmentResponse.requestProvider Type Reference: Added Target Types PractitionerRole, Organization EnrollmentResponse.requestOrganization deleted http://hl7.org/fhir/ValueSet/remittance-outcome|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

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

Path Definition Type Reference
EnrollmentResponse.status A code specifying the state of the resource instance. Required FinancialResourceStatusCodes
EnrollmentResponse.outcome The outcome of the processing. Required RemittanceOutcome

Search parameters for 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 N token The status of the enrollment response EnrollmentResponse.status