R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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

Work Group

Maturity Level: 0

Draft

Compartments: Not linked to any defined compartments

This resource provides enrollment and plan details from the processing of an Enrollment 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.

Structure

Name	Flags	Card.	Type	Description & Constraints
EnrollmentResponse	D		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 Financial Resource Status Codes (Required)
request		0..1	Reference(EnrollmentRequest)	Claim reference
outcome		0..1	code	complete \| error \| partial RemittanceOutcome (Required)
disposition		0..1	string	Disposition Message
created		0..1	dateTime	Creation date
organization		0..1	Reference(Organization)	Insurer
requestProvider		0..1	Reference(Practitioner)	Responsible practitioner
requestOrganization		0..1	Reference(Organization)	Responsible organization
Documentation for this format

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 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(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
</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>", // complete | error | partial
  "disposition" : "<string>", // Disposition Message
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) } // Responsible organization
}

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

Changes since DSTU2

EnrollmentResponse

EnrollmentResponse.status

Added Element

EnrollmentResponse.ruleset

deleted

EnrollmentResponse.originalRuleset

deleted

See the Full Difference for further information

This analysis is available 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.).

Structure

Name	Flags	Card.	Type	Description & Constraints
EnrollmentResponse	D		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 Financial Resource Status Codes (Required)
request		0..1	Reference(EnrollmentRequest)	Claim reference
outcome		0..1	code	complete \| error \| partial RemittanceOutcome (Required)
disposition		0..1	string	Disposition Message
created		0..1	dateTime	Creation date
organization		0..1	Reference(Organization)	Insurer
requestProvider		0..1	Reference(Practitioner)	Responsible practitioner
requestOrganization		0..1	Reference(Organization)	Responsible organization
Documentation for this format

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 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(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
</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>", // complete | error | partial
  "disposition" : "<string>", // Disposition Message
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) } // Responsible organization
}

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

Changes since DSTU2

EnrollmentResponse

EnrollmentResponse.status

Added Element

EnrollmentResponse.ruleset

deleted

EnrollmentResponse.originalRuleset

deleted

See the Full Difference for further information

This analysis is available 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.).

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

13.5.2.1 Terminology Bindings

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

Path

Definition

Type

Reference

EnrollmentResponse.status

A code specifying the state of the resource instance.

Required

Financial Resource Status Codes

EnrollmentResponse.outcome

The outcome of the processing.

Required

RemittanceOutcome

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

Name	Type	Description	Expression	In Common
identifier	token	The business identifier of the EnrollmentResponse	EnrollmentResponse.identifier
organization	reference	The organization who generated this resource	EnrollmentResponse.organization (Organization)
request	reference	The reference to the claim	EnrollmentResponse.request (EnrollmentRequest)
status	token	The status of the enrollment response	EnrollmentResponse.status