v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: IN2 - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the IN2 logical model.

Guidance on how to interpret the contents of this table can be found here

0. IN2
Definition

Insurance Additional Information

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IN2.insuredsEmployeeID
Definition

Insured's Employee ID

ShortinsuredsEmployeeID
Control0..*
TypeCX
4. IN2.insuredsSocialSecurityNumber
Definition

Insured's Social Security Number

ShortinsuredsSocialSecurityNumber
Control0..1
TypeST
6. IN2.insuredsEmployersNameandID
Definition

Insured's Employer's Name and ID

ShortinsuredsEmployersNameandID
Control0..*
TypeXCN
8. IN2.employerInformationData
Definition

Employer Information Data

ShortemployerInformationData
Control0..1
TypeCWE
10. IN2.mailClaimParty
Definition

Mail Claim Party

ShortmailClaimParty
Control0..*
TypeCWE
12. IN2.medicareHealthInsCardNumber
Definition

Medicare Health Ins Card Number

ShortmedicareHealthInsCardNumber
Control0..1
TypeST
14. IN2.medicaidCaseName
Definition

Medicaid Case Name

ShortmedicaidCaseName
Control0..*
TypeXPN
16. IN2.medicaidCaseNumber
Definition

Medicaid Case Number

ShortmedicaidCaseNumber
Control0..1
TypeST
18. IN2.militarySponsorName
Definition

Military Sponsor Name

ShortmilitarySponsorName
Control0..*
TypeXPN
20. IN2.militaryIDNumber
Definition

Military ID Number

ShortmilitaryIDNumber
Control0..1
TypeST
22. IN2.dependentOfMilitaryRecipient
Definition

Dependent Of Military Recipient

ShortdependentOfMilitaryRecipient
Control0..1
TypeCWE
24. IN2.militaryOrganization
Definition

Military Organization

ShortmilitaryOrganization
Control0..1
TypeST
26. IN2.militaryStation
Definition

Military Station

ShortmilitaryStation
Control0..1
TypeST
28. IN2.militaryService
Definition

Military Service

ShortmilitaryService
Control0..1
TypeCWE
30. IN2.militaryRankGrade
Definition

Military RankGrade

ShortmilitaryRankGrade
Control0..1
TypeCWE
32. IN2.militaryStatus
Definition

Military Status

ShortmilitaryStatus
Control0..1
TypeCWE
34. IN2.militaryRetireDate
Definition

Military Retire Date

ShortmilitaryRetireDate
Control0..1
TypeDT
36. IN2.militaryNon-AvailCertOnFile
Definition

Military Non-Avail Cert On File

ShortmilitaryNon-AvailCertOnFile
Control0..1
TypeID
Max Length1
38. IN2.babyCoverage
Definition

Baby Coverage

ShortbabyCoverage
Control0..1
TypeID
Max Length1
40. IN2.combineBabyBill
Definition

Combine Baby Bill

ShortcombineBabyBill
Control0..1
TypeID
Max Length1
42. IN2.bloodDeductible
Definition

Blood Deductible

ShortbloodDeductible
Control0..1
TypeST
44. IN2.specialCoverageApprovalName
Definition

Special Coverage Approval Name

ShortspecialCoverageApprovalName
Control0..*
TypeXPN
46. IN2.specialCoverageApprovalTitle
Definition

Special Coverage Approval Title

ShortspecialCoverageApprovalTitle
Control0..1
TypeST
48. IN2.non-CoveredInsuranceCode
Definition

Non-Covered Insurance Code

Shortnon-CoveredInsuranceCode
Control0..*
TypeCWE
50. IN2.payorID
Definition

Payor ID

ShortpayorID
Control0..*
TypeCX
52. IN2.payorSubscriberID
Definition

Payor Subscriber ID

ShortpayorSubscriberID
Control0..*
TypeCX
54. IN2.eligibilitySource
Definition

Eligibility Source

ShorteligibilitySource
Control0..1
TypeCWE
56. IN2.roomCoverageTypeAmount
Definition

Room Coverage TypeAmount

ShortroomCoverageTypeAmount
Control0..*
TypeRMC
58. IN2.policyTypeAmount
Definition

Policy TypeAmount

ShortpolicyTypeAmount
Control0..*
TypePTA
60. IN2.dailyDeductible
Definition

Daily Deductible

ShortdailyDeductible
Control0..1
TypeDDI
62. IN2.livingDependency
Definition

Living Dependency

ShortlivingDependency
Control0..1
TypeCWE
64. IN2.ambulatoryStatus
Definition

Ambulatory Status

ShortambulatoryStatus
Control0..*
TypeCWE
66. IN2.citizenship
Definition

Citizenship

Shortcitizenship
Control0..*
TypeCWE
68. IN2.primaryLanguage
Definition

Primary Language

ShortprimaryLanguage
Control0..1
TypeCWE
70. IN2.livingArrangement
Definition

Living Arrangement

ShortlivingArrangement
Control0..1
TypeCWE
72. IN2.publicityCode
Definition

Publicity Code

ShortpublicityCode
Control0..1
TypeCWE
74. IN2.protectionIndicator
Definition

Protection Indicator

ShortprotectionIndicator
Control0..1
TypeID
Max Length1
76. IN2.studentIndicator
Definition

Student Indicator

ShortstudentIndicator
Control0..1
TypeCWE
78. IN2.religion
Definition

Religion

Shortreligion
Control0..1
TypeCWE
80. IN2.mothersMaidenName
Definition

Mother's Maiden Name

ShortmothersMaidenName
Control0..*
TypeXPN
82. IN2.nationality
Definition

Nationality

Shortnationality
Control0..1
TypeCWE
84. IN2.ethnicGroup
Definition

Ethnic Group

ShortethnicGroup
Control0..*
TypeCWE
86. IN2.maritalStatus
Definition

Marital Status

ShortmaritalStatus
Control0..*
TypeCWE
88. IN2.insuredsEmploymentStartDate
Definition

Insured's Employment Start Date

ShortinsuredsEmploymentStartDate
Control0..1
TypeDT
90. IN2.employmentStopDate
Definition

Employment Stop Date

ShortemploymentStopDate
Control0..1
TypeDT
92. IN2.jobTitle
Definition

Job Title

ShortjobTitle
Control0..1
TypeST
94. IN2.jobCodeClass
Definition

Job CodeClass

ShortjobCodeClass
Control0..1
TypeJCC
96. IN2.jobStatus
Definition

Job Status

ShortjobStatus
Control0..1
TypeCWE
98. IN2.employerContactPersonName
Definition

Employer Contact Person Name

ShortemployerContactPersonName
Control0..*
TypeXPN
100. IN2.employerContactPersonPhoneNumber
Definition

Employer Contact Person Phone Number

ShortemployerContactPersonPhoneNumber
Control0..*
TypeXTN
102. IN2.employerContactReason
Definition

Employer Contact Reason

ShortemployerContactReason
Control0..1
TypeCWE
104. IN2.insuredsContactPersonsName
Definition

Insured's Contact Person's Name

ShortinsuredsContactPersonsName
Control0..*
TypeXPN
106. IN2.insuredsContactPersonPhoneNumber
Definition

Insured's Contact Person Phone Number

ShortinsuredsContactPersonPhoneNumber
Control0..*
TypeXTN
108. IN2.insuredsContactPersonReason
Definition

Insured's Contact Person Reason

ShortinsuredsContactPersonReason
Control0..*
TypeCWE
110. IN2.relationshiptothePatientStartDate
Definition

Relationship to the Patient Start Date

ShortrelationshiptothePatientStartDate
Control0..1
TypeDT
112. IN2.relationshiptothePatientStopDate
Definition

Relationship to the Patient Stop Date

ShortrelationshiptothePatientStopDate
Control0..*
TypeDT
114. IN2.insuranceCoContactReason
Definition

Insurance Co Contact Reason

ShortinsuranceCoContactReason
Control0..1
TypeCWE
116. IN2.insuranceCoContactPhoneNumber
Definition

Insurance Co Contact Phone Number

ShortinsuranceCoContactPhoneNumber
Control0..*
TypeXTN
118. IN2.policyScope
Definition

Policy Scope

ShortpolicyScope
Control0..1
TypeCWE
120. IN2.policySource
Definition

Policy Source

ShortpolicySource
Control0..1
TypeCWE
122. IN2.patientMemberNumber
Definition

Patient Member Number

ShortpatientMemberNumber
Control0..1
TypeCX
124. IN2.guarantorsRelationshiptoInsured
Definition

Guarantor's Relationship to Insured

ShortguarantorsRelationshiptoInsured
Control0..1
TypeCWE
126. IN2.insuredsPhoneNumber-Home
Definition

Insured's Phone Number - Home

ShortinsuredsPhoneNumber-Home
Control0..*
TypeXTN
128. IN2.insuredsEmployerPhoneNumber
Definition

Insured's Employer Phone Number

ShortinsuredsEmployerPhoneNumber
Control0..*
TypeXTN
130. IN2.militaryHandicappedProgram
Definition

Military Handicapped Program

ShortmilitaryHandicappedProgram
Control0..1
TypeCWE
132. IN2.suspendFlag
Definition

Suspend Flag

ShortsuspendFlag
Control0..1
TypeID
Max Length1
134. IN2.copayLimitFlag
Definition

Copay Limit Flag

ShortcopayLimitFlag
Control0..1
TypeID
Max Length1
136. IN2.stoplossLimitFlag
Definition

Stoploss Limit Flag

ShortstoplossLimitFlag
Control0..1
TypeID
Max Length1
138. IN2.insuredOrganizationNameandID
Definition

Insured Organization Name and ID

ShortinsuredOrganizationNameandID
Control0..*
TypeXON
140. IN2.insuredEmployerOrganizationNameandID
Definition

Insured Employer Organization Name and ID

ShortinsuredEmployerOrganizationNameandID
Control0..*
TypeXON
142. IN2.race
Definition

Race

Shortrace
Control0..*
TypeCWE
144. IN2.patientsRelationshiptoInsured
Definition

Patient's Relationship to Insured

ShortpatientsRelationshiptoInsured
Control0..1
TypeCWE
146. IN2.co-PayAmount
Definition

Co-Pay Amount

Shortco-PayAmount
Control0..1
TypeCP

Guidance on how to interpret the contents of this table can be found here

0. IN2
Definition

Insurance Additional Information


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. IN2.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. IN2.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. IN2.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on IN2.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. IN2.insuredsEmployeeID
Definition

Insured's Employee ID

ShortinsuredsEmployeeID
Control0..*
TypeCX
10. IN2.insuredsSocialSecurityNumber
Definition

Insured's Social Security Number

ShortinsuredsSocialSecurityNumber
Control0..1
TypeST
12. IN2.insuredsEmployersNameandID
Definition

Insured's Employer's Name and ID

ShortinsuredsEmployersNameandID
Control0..*
TypeXCN
14. IN2.employerInformationData
Definition

Employer Information Data

ShortemployerInformationData
Control0..1
TypeCWE
16. IN2.mailClaimParty
Definition

Mail Claim Party

ShortmailClaimParty
Control0..*
TypeCWE
18. IN2.medicareHealthInsCardNumber
Definition

Medicare Health Ins Card Number

ShortmedicareHealthInsCardNumber
Control0..1
TypeST
20. IN2.medicaidCaseName
Definition

Medicaid Case Name

ShortmedicaidCaseName
Control0..*
TypeXPN
22. IN2.medicaidCaseNumber
Definition

Medicaid Case Number

ShortmedicaidCaseNumber
Control0..1
TypeST
24. IN2.militarySponsorName
Definition

Military Sponsor Name

ShortmilitarySponsorName
Control0..*
TypeXPN
26. IN2.militaryIDNumber
Definition

Military ID Number

ShortmilitaryIDNumber
Control0..1
TypeST
28. IN2.dependentOfMilitaryRecipient
Definition

Dependent Of Military Recipient

ShortdependentOfMilitaryRecipient
Control0..1
TypeCWE
30. IN2.militaryOrganization
Definition

Military Organization

ShortmilitaryOrganization
Control0..1
TypeST
32. IN2.militaryStation
Definition

Military Station

ShortmilitaryStation
Control0..1
TypeST
34. IN2.militaryService
Definition

Military Service

ShortmilitaryService
Control0..1
TypeCWE
36. IN2.militaryRankGrade
Definition

Military RankGrade

ShortmilitaryRankGrade
Control0..1
TypeCWE
38. IN2.militaryStatus
Definition

Military Status

ShortmilitaryStatus
Control0..1
TypeCWE
40. IN2.militaryRetireDate
Definition

Military Retire Date

ShortmilitaryRetireDate
Control0..1
TypeDT
42. IN2.militaryNon-AvailCertOnFile
Definition

Military Non-Avail Cert On File

ShortmilitaryNon-AvailCertOnFile
Control0..1
TypeID
Max Length1
44. IN2.babyCoverage
Definition

Baby Coverage

ShortbabyCoverage
Control0..1
TypeID
Max Length1
46. IN2.combineBabyBill
Definition

Combine Baby Bill

ShortcombineBabyBill
Control0..1
TypeID
Max Length1
48. IN2.bloodDeductible
Definition

Blood Deductible

ShortbloodDeductible
Control0..1
TypeST
50. IN2.specialCoverageApprovalName
Definition

Special Coverage Approval Name

ShortspecialCoverageApprovalName
Control0..*
TypeXPN
52. IN2.specialCoverageApprovalTitle
Definition

Special Coverage Approval Title

ShortspecialCoverageApprovalTitle
Control0..1
TypeST
54. IN2.non-CoveredInsuranceCode
Definition

Non-Covered Insurance Code

Shortnon-CoveredInsuranceCode
Control0..*
TypeCWE
56. IN2.payorID
Definition

Payor ID

ShortpayorID
Control0..*
TypeCX
58. IN2.payorSubscriberID
Definition

Payor Subscriber ID

ShortpayorSubscriberID
Control0..*
TypeCX
60. IN2.eligibilitySource
Definition

Eligibility Source

ShorteligibilitySource
Control0..1
TypeCWE
62. IN2.roomCoverageTypeAmount
Definition

Room Coverage TypeAmount

ShortroomCoverageTypeAmount
Control0..*
TypeRMC
64. IN2.policyTypeAmount
Definition

Policy TypeAmount

ShortpolicyTypeAmount
Control0..*
TypePTA
66. IN2.dailyDeductible
Definition

Daily Deductible

ShortdailyDeductible
Control0..1
TypeDDI
68. IN2.livingDependency
Definition

Living Dependency

ShortlivingDependency
Control0..1
TypeCWE
70. IN2.ambulatoryStatus
Definition

Ambulatory Status

ShortambulatoryStatus
Control0..*
TypeCWE
72. IN2.citizenship
Definition

Citizenship

Shortcitizenship
Control0..*
TypeCWE
74. IN2.primaryLanguage
Definition

Primary Language

ShortprimaryLanguage
Control0..1
TypeCWE
76. IN2.livingArrangement
Definition

Living Arrangement

ShortlivingArrangement
Control0..1
TypeCWE
78. IN2.publicityCode
Definition

Publicity Code

ShortpublicityCode
Control0..1
TypeCWE
80. IN2.protectionIndicator
Definition

Protection Indicator

ShortprotectionIndicator
Control0..1
TypeID
Max Length1
82. IN2.studentIndicator
Definition

Student Indicator

ShortstudentIndicator
Control0..1
TypeCWE
84. IN2.religion
Definition

Religion

Shortreligion
Control0..1
TypeCWE
86. IN2.mothersMaidenName
Definition

Mother's Maiden Name

ShortmothersMaidenName
Control0..*
TypeXPN
88. IN2.nationality
Definition

Nationality

Shortnationality
Control0..1
TypeCWE
90. IN2.ethnicGroup
Definition

Ethnic Group

ShortethnicGroup
Control0..*
TypeCWE
92. IN2.maritalStatus
Definition

Marital Status

ShortmaritalStatus
Control0..*
TypeCWE
94. IN2.insuredsEmploymentStartDate
Definition

Insured's Employment Start Date

ShortinsuredsEmploymentStartDate
Control0..1
TypeDT
96. IN2.employmentStopDate
Definition

Employment Stop Date

ShortemploymentStopDate
Control0..1
TypeDT
98. IN2.jobTitle
Definition

Job Title

ShortjobTitle
Control0..1
TypeST
100. IN2.jobCodeClass
Definition

Job CodeClass

ShortjobCodeClass
Control0..1
TypeJCC
102. IN2.jobStatus
Definition

Job Status

ShortjobStatus
Control0..1
TypeCWE
104. IN2.employerContactPersonName
Definition

Employer Contact Person Name

ShortemployerContactPersonName
Control0..*
TypeXPN
106. IN2.employerContactPersonPhoneNumber
Definition

Employer Contact Person Phone Number

ShortemployerContactPersonPhoneNumber
Control0..*
TypeXTN
108. IN2.employerContactReason
Definition

Employer Contact Reason

ShortemployerContactReason
Control0..1
TypeCWE
110. IN2.insuredsContactPersonsName
Definition

Insured's Contact Person's Name

ShortinsuredsContactPersonsName
Control0..*
TypeXPN
112. IN2.insuredsContactPersonPhoneNumber
Definition

Insured's Contact Person Phone Number

ShortinsuredsContactPersonPhoneNumber
Control0..*
TypeXTN
114. IN2.insuredsContactPersonReason
Definition

Insured's Contact Person Reason

ShortinsuredsContactPersonReason
Control0..*
TypeCWE
116. IN2.relationshiptothePatientStartDate
Definition

Relationship to the Patient Start Date

ShortrelationshiptothePatientStartDate
Control0..1
TypeDT
118. IN2.relationshiptothePatientStopDate
Definition

Relationship to the Patient Stop Date

ShortrelationshiptothePatientStopDate
Control0..*
TypeDT
120. IN2.insuranceCoContactReason
Definition

Insurance Co Contact Reason

ShortinsuranceCoContactReason
Control0..1
TypeCWE
122. IN2.insuranceCoContactPhoneNumber
Definition

Insurance Co Contact Phone Number

ShortinsuranceCoContactPhoneNumber
Control0..*
TypeXTN
124. IN2.policyScope
Definition

Policy Scope

ShortpolicyScope
Control0..1
TypeCWE
126. IN2.policySource
Definition

Policy Source

ShortpolicySource
Control0..1
TypeCWE
128. IN2.patientMemberNumber
Definition

Patient Member Number

ShortpatientMemberNumber
Control0..1
TypeCX
130. IN2.guarantorsRelationshiptoInsured
Definition

Guarantor's Relationship to Insured

ShortguarantorsRelationshiptoInsured
Control0..1
TypeCWE
132. IN2.insuredsPhoneNumber-Home
Definition

Insured's Phone Number - Home

ShortinsuredsPhoneNumber-Home
Control0..*
TypeXTN
134. IN2.insuredsEmployerPhoneNumber
Definition

Insured's Employer Phone Number

ShortinsuredsEmployerPhoneNumber
Control0..*
TypeXTN
136. IN2.militaryHandicappedProgram
Definition

Military Handicapped Program

ShortmilitaryHandicappedProgram
Control0..1
TypeCWE
138. IN2.suspendFlag
Definition

Suspend Flag

ShortsuspendFlag
Control0..1
TypeID
Max Length1
140. IN2.copayLimitFlag
Definition

Copay Limit Flag

ShortcopayLimitFlag
Control0..1
TypeID
Max Length1
142. IN2.stoplossLimitFlag
Definition

Stoploss Limit Flag

ShortstoplossLimitFlag
Control0..1
TypeID
Max Length1
144. IN2.insuredOrganizationNameandID
Definition

Insured Organization Name and ID

ShortinsuredOrganizationNameandID
Control0..*
TypeXON
146. IN2.insuredEmployerOrganizationNameandID
Definition

Insured Employer Organization Name and ID

ShortinsuredEmployerOrganizationNameandID
Control0..*
TypeXON
148. IN2.race
Definition

Race

Shortrace
Control0..*
TypeCWE
150. IN2.patientsRelationshiptoInsured
Definition

Patient's Relationship to Insured

ShortpatientsRelationshiptoInsured
Control0..1
TypeCWE
152. IN2.co-PayAmount
Definition

Co-Pay Amount

Shortco-PayAmount
Control0..1
TypeCP

Guidance on how to interpret the contents of this table can be found here

0. IN2
Definition

Insurance Additional Information

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. IN2.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. IN2.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. IN2.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. IN2.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. IN2.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. IN2.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. IN2.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on IN2.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. IN2.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on IN2.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. IN2.insuredsEmployeeID
Definition

Insured's Employee ID

ShortinsuredsEmployeeID
Control0..*
TypeCX
20. IN2.insuredsSocialSecurityNumber
Definition

Insured's Social Security Number

ShortinsuredsSocialSecurityNumber
Control0..1
TypeST
22. IN2.insuredsEmployersNameandID
Definition

Insured's Employer's Name and ID

ShortinsuredsEmployersNameandID
Control0..*
TypeXCN
24. IN2.employerInformationData
Definition

Employer Information Data

ShortemployerInformationData
Control0..1
TypeCWE
26. IN2.mailClaimParty
Definition

Mail Claim Party

ShortmailClaimParty
Control0..*
TypeCWE
28. IN2.medicareHealthInsCardNumber
Definition

Medicare Health Ins Card Number

ShortmedicareHealthInsCardNumber
Control0..1
TypeST
30. IN2.medicaidCaseName
Definition

Medicaid Case Name

ShortmedicaidCaseName
Control0..*
TypeXPN
32. IN2.medicaidCaseNumber
Definition

Medicaid Case Number

ShortmedicaidCaseNumber
Control0..1
TypeST
34. IN2.militarySponsorName
Definition

Military Sponsor Name

ShortmilitarySponsorName
Control0..*
TypeXPN
36. IN2.militaryIDNumber
Definition

Military ID Number

ShortmilitaryIDNumber
Control0..1
TypeST
38. IN2.dependentOfMilitaryRecipient
Definition

Dependent Of Military Recipient

ShortdependentOfMilitaryRecipient
Control0..1
TypeCWE
40. IN2.militaryOrganization
Definition

Military Organization

ShortmilitaryOrganization
Control0..1
TypeST
42. IN2.militaryStation
Definition

Military Station

ShortmilitaryStation
Control0..1
TypeST
44. IN2.militaryService
Definition

Military Service

ShortmilitaryService
Control0..1
TypeCWE
46. IN2.militaryRankGrade
Definition

Military RankGrade

ShortmilitaryRankGrade
Control0..1
TypeCWE
48. IN2.militaryStatus
Definition

Military Status

ShortmilitaryStatus
Control0..1
TypeCWE
50. IN2.militaryRetireDate
Definition

Military Retire Date

ShortmilitaryRetireDate
Control0..1
TypeDT
52. IN2.militaryNon-AvailCertOnFile
Definition

Military Non-Avail Cert On File

ShortmilitaryNon-AvailCertOnFile
Control0..1
TypeID
Max Length1
54. IN2.babyCoverage
Definition

Baby Coverage

ShortbabyCoverage
Control0..1
TypeID
Max Length1
56. IN2.combineBabyBill
Definition

Combine Baby Bill

ShortcombineBabyBill
Control0..1
TypeID
Max Length1
58. IN2.bloodDeductible
Definition

Blood Deductible

ShortbloodDeductible
Control0..1
TypeST
60. IN2.specialCoverageApprovalName
Definition

Special Coverage Approval Name

ShortspecialCoverageApprovalName
Control0..*
TypeXPN
62. IN2.specialCoverageApprovalTitle
Definition

Special Coverage Approval Title

ShortspecialCoverageApprovalTitle
Control0..1
TypeST
64. IN2.non-CoveredInsuranceCode
Definition

Non-Covered Insurance Code

Shortnon-CoveredInsuranceCode
Control0..*
TypeCWE
66. IN2.payorID
Definition

Payor ID

ShortpayorID
Control0..*
TypeCX
68. IN2.payorSubscriberID
Definition

Payor Subscriber ID

ShortpayorSubscriberID
Control0..*
TypeCX
70. IN2.eligibilitySource
Definition

Eligibility Source

ShorteligibilitySource
Control0..1
TypeCWE
72. IN2.roomCoverageTypeAmount
Definition

Room Coverage TypeAmount

ShortroomCoverageTypeAmount
Control0..*
TypeRMC
74. IN2.policyTypeAmount
Definition

Policy TypeAmount

ShortpolicyTypeAmount
Control0..*
TypePTA
76. IN2.dailyDeductible
Definition

Daily Deductible

ShortdailyDeductible
Control0..1
TypeDDI
78. IN2.livingDependency
Definition

Living Dependency

ShortlivingDependency
Control0..1
TypeCWE
80. IN2.ambulatoryStatus
Definition

Ambulatory Status

ShortambulatoryStatus
Control0..*
TypeCWE
82. IN2.citizenship
Definition

Citizenship

Shortcitizenship
Control0..*
TypeCWE
84. IN2.primaryLanguage
Definition

Primary Language

ShortprimaryLanguage
Control0..1
TypeCWE
86. IN2.livingArrangement
Definition

Living Arrangement

ShortlivingArrangement
Control0..1
TypeCWE
88. IN2.publicityCode
Definition

Publicity Code

ShortpublicityCode
Control0..1
TypeCWE
90. IN2.protectionIndicator
Definition

Protection Indicator

ShortprotectionIndicator
Control0..1
TypeID
Max Length1
92. IN2.studentIndicator
Definition

Student Indicator

ShortstudentIndicator
Control0..1
TypeCWE
94. IN2.religion
Definition

Religion

Shortreligion
Control0..1
TypeCWE
96. IN2.mothersMaidenName
Definition

Mother's Maiden Name

ShortmothersMaidenName
Control0..*
TypeXPN
98. IN2.nationality
Definition

Nationality

Shortnationality
Control0..1
TypeCWE
100. IN2.ethnicGroup
Definition

Ethnic Group

ShortethnicGroup
Control0..*
TypeCWE
102. IN2.maritalStatus
Definition

Marital Status

ShortmaritalStatus
Control0..*
TypeCWE
104. IN2.insuredsEmploymentStartDate
Definition

Insured's Employment Start Date

ShortinsuredsEmploymentStartDate
Control0..1
TypeDT
106. IN2.employmentStopDate
Definition

Employment Stop Date

ShortemploymentStopDate
Control0..1
TypeDT
108. IN2.jobTitle
Definition

Job Title

ShortjobTitle
Control0..1
TypeST
110. IN2.jobCodeClass
Definition

Job CodeClass

ShortjobCodeClass
Control0..1
TypeJCC
112. IN2.jobStatus
Definition

Job Status

ShortjobStatus
Control0..1
TypeCWE
114. IN2.employerContactPersonName
Definition

Employer Contact Person Name

ShortemployerContactPersonName
Control0..*
TypeXPN
116. IN2.employerContactPersonPhoneNumber
Definition

Employer Contact Person Phone Number

ShortemployerContactPersonPhoneNumber
Control0..*
TypeXTN
118. IN2.employerContactReason
Definition

Employer Contact Reason

ShortemployerContactReason
Control0..1
TypeCWE
120. IN2.insuredsContactPersonsName
Definition

Insured's Contact Person's Name

ShortinsuredsContactPersonsName
Control0..*
TypeXPN
122. IN2.insuredsContactPersonPhoneNumber
Definition

Insured's Contact Person Phone Number

ShortinsuredsContactPersonPhoneNumber
Control0..*
TypeXTN
124. IN2.insuredsContactPersonReason
Definition

Insured's Contact Person Reason

ShortinsuredsContactPersonReason
Control0..*
TypeCWE
126. IN2.relationshiptothePatientStartDate
Definition

Relationship to the Patient Start Date

ShortrelationshiptothePatientStartDate
Control0..1
TypeDT
128. IN2.relationshiptothePatientStopDate
Definition

Relationship to the Patient Stop Date

ShortrelationshiptothePatientStopDate
Control0..*
TypeDT
130. IN2.insuranceCoContactReason
Definition

Insurance Co Contact Reason

ShortinsuranceCoContactReason
Control0..1
TypeCWE
132. IN2.insuranceCoContactPhoneNumber
Definition

Insurance Co Contact Phone Number

ShortinsuranceCoContactPhoneNumber
Control0..*
TypeXTN
134. IN2.policyScope
Definition

Policy Scope

ShortpolicyScope
Control0..1
TypeCWE
136. IN2.policySource
Definition

Policy Source

ShortpolicySource
Control0..1
TypeCWE
138. IN2.patientMemberNumber
Definition

Patient Member Number

ShortpatientMemberNumber
Control0..1
TypeCX
140. IN2.guarantorsRelationshiptoInsured
Definition

Guarantor's Relationship to Insured

ShortguarantorsRelationshiptoInsured
Control0..1
TypeCWE
142. IN2.insuredsPhoneNumber-Home
Definition

Insured's Phone Number - Home

ShortinsuredsPhoneNumber-Home
Control0..*
TypeXTN
144. IN2.insuredsEmployerPhoneNumber
Definition

Insured's Employer Phone Number

ShortinsuredsEmployerPhoneNumber
Control0..*
TypeXTN
146. IN2.militaryHandicappedProgram
Definition

Military Handicapped Program

ShortmilitaryHandicappedProgram
Control0..1
TypeCWE
148. IN2.suspendFlag
Definition

Suspend Flag

ShortsuspendFlag
Control0..1
TypeID
Max Length1
150. IN2.copayLimitFlag
Definition

Copay Limit Flag

ShortcopayLimitFlag
Control0..1
TypeID
Max Length1
152. IN2.stoplossLimitFlag
Definition

Stoploss Limit Flag

ShortstoplossLimitFlag
Control0..1
TypeID
Max Length1
154. IN2.insuredOrganizationNameandID
Definition

Insured Organization Name and ID

ShortinsuredOrganizationNameandID
Control0..*
TypeXON
156. IN2.insuredEmployerOrganizationNameandID
Definition

Insured Employer Organization Name and ID

ShortinsuredEmployerOrganizationNameandID
Control0..*
TypeXON
158. IN2.race
Definition

Race

Shortrace
Control0..*
TypeCWE
160. IN2.patientsRelationshiptoInsured
Definition

Patient's Relationship to Insured

ShortpatientsRelationshiptoInsured
Control0..1
TypeCWE
162. IN2.co-PayAmount
Definition

Co-Pay Amount

Shortco-PayAmount
Control0..1
TypeCP