Current Build

13.5 Resource EnrollmentResponse - Content

Financial Management Work GroupMaturity Level: 0 Trial Use Compartments: Not linked to any defined compartments

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

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
... outcome 0..1codequeued | complete | error | partial
RemittanceOutcome (Required)
... 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

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(Practitioner|PractitionerRole|Organization) 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(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible practitioner
]

Changes since R3

EnrollmentResponse
EnrollmentResponse.outcome
  • Type changed from CodeableConcept to code
EnrollmentResponse.requestProvider
  • Type changed from Reference(Practitioner) to Reference(Practitioner|PractitionerRole|Organization)
EnrollmentResponse.requestOrganization
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test of which 1 fail to execute.)

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
... outcome 0..1codequeued | complete | error | partial
RemittanceOutcome (Required)
... 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

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(Practitioner|PractitionerRole|Organization) 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(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible practitioner
]

Changes since Release 3

EnrollmentResponse
EnrollmentResponse.outcome
  • Type changed from CodeableConcept to code
EnrollmentResponse.requestProvider
  • Type changed from Reference(Practitioner) to Reference(Practitioner|PractitionerRole|Organization)
EnrollmentResponse.requestOrganization
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test of which 1 fail to execute.)

 

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

PathDefinitionTypeReference
EnrollmentResponse.status A code specifying the state of the resource instance.RequiredFinancialResourceStatusCodes
EnrollmentResponse.outcome The outcome of the processing.RequiredRemittanceOutcome

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)
statustokenThe status of the enrollment responseEnrollmentResponse.status