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 of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This resource provides enrollment and plan details from the processing of an Enrollment 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
| Name | Flags | Card. | Type | Description & Constraints doco |
|---|---|---|---|---|
| .. EnrollmentResponse | 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 | CodeableConcept | 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 | |
doco Documentation for this format | ||||
UML Diagram (Legend)
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><!-- 0..1 CodeableConcept complete | error | partial --></outcome> <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
{doco
"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" : { CodeableConcept }, // 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/> .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[ CodeableConcept ]; # 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
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 doco |
|---|---|---|---|---|
| .. EnrollmentResponse | 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 | CodeableConcept | 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 | |
doco Documentation for this format | ||||
UML Diagram (Legend)
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><!-- 0..1 CodeableConcept complete | error | partial --></outcome> <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
{doco
"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" : { CodeableConcept }, // 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/> .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[ CodeableConcept ]; # 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
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 (for ) + JSON Schema, ShEx (for Turtle)
| 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 |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.