Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

13.5 Resource EnrollmentResponse - Content

Financial Management icon Work GroupMaturity Level: 0 Trial UseSecurity 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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentResponse TUDomainResourceEnrollmentResponse resource

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier

... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... request 0..1Reference(EnrollmentRequest)Claim reference
... disposition 0..1stringDisposition Message
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Insurer
... requestProvider 0..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner

doco Documentation for this format

See the Extensions for this resource

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><!-- 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:EnrollmentResponse.requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Responsible practitioner
]

Changes since R4

EnrollmentResponse
EnrollmentResponse.outcome
  • Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/enrollment-outcome|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/enrollment-outcome|5.0.0-ballot

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentResponse TUDomainResourceEnrollmentResponse resource

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier

... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... request 0..1Reference(EnrollmentRequest)Claim reference
... disposition 0..1stringDisposition Message
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Insurer
... requestProvider 0..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner

doco Documentation for this format

See the Extensions for this resource

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><!-- 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:EnrollmentResponse.requestProvider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Responsible practitioner
]

Changes since Release 4

EnrollmentResponse
EnrollmentResponse.outcome
  • Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/enrollment-outcome|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0 to http://hl7.org/fhir/ValueSet/enrollment-outcome|5.0.0-ballot

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

 

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

PathDefinitionTypeReference
EnrollmentResponse.status

This value set includes Status codes.

RequiredFinancialResourceStatusCodes
EnrollmentResponse.outcome

The outcome of the processing.

RequiredEnrollmentOutcome

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

NameTypeDescriptionExpressionIn Common
identifiertokenThe business identifier of the EnrollmentResponseEnrollmentResponse.identifier
requestreferenceThe reference to the claimEnrollmentResponse.request
(EnrollmentRequest)
status NtokenThe status of the enrollment responseEnrollmentResponse.status