R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - 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.4 Resource EnrollmentRequest - Content

Financial Management icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Patient Compartments: Patient

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

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 EnrollmentRequest resource allows for the addition and removal of plan subscribers and their dependents to health insurance coverage.

Todo

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentRequest TUDomainResourceEnroll in coverage

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

... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (Required)
... created 0..1dateTimeCreation date
... provider 0..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... candidate 0..1Reference(Patient)The subject to be enrolled
... coverage 0..1Reference(Coverage)Insurance information

doco Documentation for this format icon

See the Extensions for this resource

XML Template

<EnrollmentRequest 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 -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <insurer><!-- 0..1 Reference(Organization) Target --></insurer>
 <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></provider>
 <candidate><!-- 0..1 Reference(Patient) The subject to be enrolled --></candidate>
 <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage>
</EnrollmentRequest>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EnrollmentRequest;
  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:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier
  fhir:status [ code ] ; # 0..1 active | cancelled | draft | entered-in-error
  fhir:created [ dateTime ] ; # 0..1 Creation date
  fhir:insurer [ Reference(Organization) ] ; # 0..1 Target
  fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Responsible practitioner
  fhir:candidate [ Reference(Patient) ] ; # 0..1 The subject to be enrolled
  fhir:coverage [ Reference(Coverage) ] ; # 0..1 Insurance information
]

Changes since R4

EnrollmentRequest
  • No Changes

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. 1 fail round-trip testing and all r3 resources are valid.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EnrollmentRequest TUDomainResourceEnroll in coverage

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

... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (Required)
... created 0..1dateTimeCreation date
... provider 0..1Reference(Practitioner | PractitionerRole | Organization)Responsible practitioner
... candidate 0..1Reference(Patient)The subject to be enrolled
... coverage 0..1Reference(Coverage)Insurance information

doco Documentation for this format icon

See the Extensions for this resource

XML Template

<EnrollmentRequest 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 -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <insurer><!-- 0..1 Reference(Organization) Target --></insurer>
 <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></provider>
 <candidate><!-- 0..1 Reference(Patient) The subject to be enrolled --></candidate>
 <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage>
</EnrollmentRequest>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EnrollmentRequest;
  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:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier
  fhir:status [ code ] ; # 0..1 active | cancelled | draft | entered-in-error
  fhir:created [ dateTime ] ; # 0..1 Creation date
  fhir:insurer [ Reference(Organization) ] ; # 0..1 Target
  fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Responsible practitioner
  fhir:candidate [ Reference(Patient) ] ; # 0..1 The subject to be enrolled
  fhir:coverage [ Reference(Coverage) ] ; # 0..1 Insurance information
]

Changes since Release 4

EnrollmentRequest
  • No Changes

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. 1 fail 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

PathValueSetTypeDocumentation
EnrollmentRequest.status FinancialResourceStatusCodes Required

This value set includes Status codes.

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to 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 EnrollmentEnrollmentRequest.identifier65 Resources
patientreferenceThe party to be enrolledEnrollmentRequest.candidate
(Patient)
66 Resources
statustokenThe status of the enrollmentEnrollmentRequest.status
subjectreferenceThe party to be enrolledEnrollmentRequest.candidate
(Patient)