This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Financial
Management
Work
Group
|
|
Security Category : Patient | Compartments : Group , 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
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
TU | DomainResource |
Enroll
in
coverage
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
Identifier
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Binding: Financial Resource Status Codes ( Required ) |
|
0..1 | dateTime |
Creation
date
|
|
|
0..1 | Reference ( Organization ) |
Target
|
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Responsible
practitioner
|
|
|
0..1 | Reference ( Patient | Group ) |
The
|
|
|
0..1 | Reference ( Coverage ) |
Insurance
information
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<EnrollmentRequest 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 --> <created value="[dateTime]"/><!-- 0..1 Creation date --> <insurer><!-- 0..1 Reference(Organization) Target --></insurer>
<</provider> <</candidate><provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></provider> <candidate><!-- 0..1 Reference(Group|Patient) The subject(s)to be enrolled --></candidate> <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage> </EnrollmentRequest>
JSON Template
{
"resourceType" : "EnrollmentRequest",
// 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
"created" : "<dateTime>", // Creation date
"insurer" : { Reference(Organization) }, // Target
"
"
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Responsible practitioner
"candidate" : { Reference(Group|Patient) }, // The subject(s)to be enrolled
"coverage" : { Reference(Coverage) } // Insurance information
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:EnrollmentRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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(Group|Patient) ] ; # 0..1 The subject(s)to be enrolled fhir:coverage [ Reference(Coverage) ] ; # 0..1 Insurance information ]
Changes
since
R3
from
both
R4
and
R4B
| EnrollmentRequest |
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
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.)
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
TU | DomainResource |
Enroll
in
coverage
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
Identifier
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Binding: Financial Resource Status Codes ( Required ) |
|
0..1 | dateTime |
Creation
date
|
|
|
0..1 | Reference ( Organization ) |
Target
|
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Responsible
practitioner
|
|
|
0..1 | Reference ( Patient | Group ) |
The
|
|
|
0..1 | Reference ( Coverage ) |
Insurance
information
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<EnrollmentRequest 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 --> <created value="[dateTime]"/><!-- 0..1 Creation date --> <insurer><!-- 0..1 Reference(Organization) Target --></insurer>
<</provider> <</candidate><provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Responsible practitioner --></provider> <candidate><!-- 0..1 Reference(Group|Patient) The subject(s)to be enrolled --></candidate> <coverage><!-- 0..1 Reference(Coverage) Insurance information --></coverage> </EnrollmentRequest>
JSON Template
{
"resourceType" : "EnrollmentRequest",
// 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
"created" : "<dateTime>", // Creation date
"insurer" : { Reference(Organization) }, // Target
"
"
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Responsible practitioner
"candidate" : { Reference(Group|Patient) }, // The subject(s)to be enrolled
"coverage" : { Reference(Coverage) } // Insurance information
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:EnrollmentRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir:# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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(Group|Patient) ] ; # 0..1 The subject(s)to be enrolled fhir:coverage [ Reference(Coverage) ] ; # 0..1 Insurance information ]
Changes
since
Release
3
from
both
R4
and
R4B
| EnrollmentRequest |
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
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.)
for
R4B
as
XML
or
JSON
.
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| EnrollmentRequest.status |
|
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.
| Name | Type | Description | Expression | In Common |
| group | reference | The parties to be enrolled |
EnrollmentRequest.candidate.where(resolve()
is
Group)
( Group ) | |
| identifier | token | The business identifier of the Enrollment | EnrollmentRequest.identifier | 59 Resources |
| patient | reference | The party to be enrolled |
( Patient ) |
61 Resources |
| status | token | The status of the enrollment | EnrollmentRequest.status | |
| subject | reference | The party to be enrolled |
EnrollmentRequest.candidate
( Group , Patient ) |