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: IN1 - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the IN1 logical model.

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

0. IN1
Definition

Insurance

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

Set ID - IN1

ShortsetID-IN1
Control1..1
TypeSI
Must Supporttrue
Max Length4
4. IN1.healthPlanID
Definition

Health Plan ID

ShorthealthPlanID
Control1..1
TypeCWE
Must Supporttrue
6. IN1.insuranceCompanyID
Definition

Insurance Company ID

ShortinsuranceCompanyID
Control1..*
TypeCX
Must Supporttrue
8. IN1.insuranceCompanyName
Definition

Insurance Company Name

ShortinsuranceCompanyName
Control0..*
TypeXON
10. IN1.insuranceCompanyAddress
Definition

Insurance Company Address

ShortinsuranceCompanyAddress
Control0..*
TypeXAD
12. IN1.insuranceCoContactPerson
Definition

Insurance Co Contact Person

ShortinsuranceCoContactPerson
Control0..*
TypeXPN
14. IN1.insuranceCoPhoneNumber
Definition

Insurance Co Phone Number

ShortinsuranceCoPhoneNumber
Control0..*
TypeXTN
16. IN1.groupNumber
Definition

Group Number

ShortgroupNumber
Control0..1
TypeST
18. IN1.groupName
Definition

Group Name

ShortgroupName
Control0..*
TypeXON
20. IN1.insuredsGroupEmpID
Definition

Insured's Group Emp ID

ShortinsuredsGroupEmpID
Control0..*
TypeCX
22. IN1.insuredsGroupEmpName
Definition

Insured's Group Emp Name

ShortinsuredsGroupEmpName
Control0..*
TypeXON
24. IN1.planEffectiveDate
Definition

Plan Effective Date

ShortplanEffectiveDate
Control0..1
TypeDT
26. IN1.planExpirationDate
Definition

Plan Expiration Date

ShortplanExpirationDate
Control0..1
TypeDT
28. IN1.authorizationInformation
Definition

Authorization Information

ShortauthorizationInformation
Control0..1
TypeAUI
30. IN1.planType
Definition

Plan Type

ShortplanType
Control0..1
TypeCWE
32. IN1.nameOfInsured
Definition

Name Of Insured

ShortnameOfInsured
Control0..*
TypeXPN
34. IN1.insuredsRelationshipToPatient
Definition

Insured's Relationship To Patient

ShortinsuredsRelationshipToPatient
Control0..1
TypeCWE
36. IN1.insuredsDateOfBirth
Definition

Insured's Date Of Birth

ShortinsuredsDateOfBirth
Control0..1
TypeDTM
38. IN1.insuredsAddress
Definition

Insured's Address

ShortinsuredsAddress
Control0..*
TypeXAD
40. IN1.assignmentOfBenefits
Definition

Assignment Of Benefits

ShortassignmentOfBenefits
Control0..1
TypeCWE
42. IN1.coordinationOfBenefits
Definition

Coordination Of Benefits

ShortcoordinationOfBenefits
Control0..1
TypeCWE
44. IN1.coordOfBenPriority
Definition

Coord Of Ben. Priority

ShortcoordOfBenPriority
Control0..1
TypeST
46. IN1.noticeOfAdmissionFlag
Definition

Notice Of Admission Flag

ShortnoticeOfAdmissionFlag
Control0..1
TypeID
Max Length1
48. IN1.noticeOfAdmissionDate
Definition

Notice Of Admission Date

ShortnoticeOfAdmissionDate
Control0..1
TypeDT
50. IN1.reportOfEligibilityFlag
Definition

Report Of Eligibility Flag

ShortreportOfEligibilityFlag
Control0..1
TypeID
Max Length1
52. IN1.reportOfEligibilityDate
Definition

Report Of Eligibility Date

ShortreportOfEligibilityDate
Control0..1
TypeDT
54. IN1.releaseInformationCode
Definition

Release Information Code

ShortreleaseInformationCode
Control0..1
TypeCWE
56. IN1.pre-AdmitCertPAC
Definition

Pre-Admit Cert (PAC)

Shortpre-AdmitCertPAC
Control0..1
TypeST
58. IN1.verificationDateTime
Definition

Verification DateTime

ShortverificationDateTime
Control0..1
TypeDTM
60. IN1.verificationBy
Definition

Verification By

ShortverificationBy
Control0..*
TypeXCN
62. IN1.typeOfAgreementCode
Definition

Type Of Agreement Code

ShorttypeOfAgreementCode
Control0..1
TypeCWE
64. IN1.billingStatus
Definition

Billing Status

ShortbillingStatus
Control0..1
TypeCWE
66. IN1.lifetimeReserveDays
Definition

Lifetime Reserve Days

ShortlifetimeReserveDays
Control0..1
TypeNM
68. IN1.delayBeforeLRDay
Definition

Delay Before L.R. Day

ShortdelayBeforeLRDay
Control0..1
TypeNM
70. IN1.companyPlanCode
Definition

Company Plan Code

ShortcompanyPlanCode
Control0..1
TypeCWE
72. IN1.policyNumber
Definition

Policy Number

ShortpolicyNumber
Control0..1
TypeST
74. IN1.policyDeductible
Definition

Policy Deductible

ShortpolicyDeductible
Control0..1
TypeCP
76. IN1.policyLimit-Amount
Definition

Policy Limit - Amount

ShortpolicyLimit-Amount
Control0..1
Type-
78. IN1.policyLimit-Days
Definition

Policy Limit - Days

ShortpolicyLimit-Days
Control0..1
TypeNM
80. IN1.roomRate-Semi-Private
Definition

Room Rate - Semi-Private

ShortroomRate-Semi-Private
Control0..1
Type-
82. IN1.roomRate-Private
Definition

Room Rate - Private

ShortroomRate-Private
Control0..1
Type-
84. IN1.insuredsEmploymentStatus
Definition

Insured's Employment Status

ShortinsuredsEmploymentStatus
Control0..1
TypeCWE
86. IN1.insuredsAdministrativeSex
Definition

Insured's Administrative Sex

ShortinsuredsAdministrativeSex
Control0..1
TypeCWE
88. IN1.insuredsEmployersAddress
Definition

Insured's Employer's Address

ShortinsuredsEmployersAddress
Control0..*
TypeXAD
90. IN1.verificationStatus
Definition

Verification Status

ShortverificationStatus
Control0..1
TypeST
92. IN1.priorInsurancePlanID
Definition

Prior Insurance Plan ID

ShortpriorInsurancePlanID
Control0..1
TypeCWE
94. IN1.coverageType
Definition

Coverage Type

ShortcoverageType
Control0..1
TypeCWE
96. IN1.handicap
Definition

Handicap

Shorthandicap
Control0..1
TypeCWE
98. IN1.insuredsIDNumber
Definition

Insured's ID Number

ShortinsuredsIDNumber
Control0..*
TypeCX
100. IN1.signatureCode
Definition

Signature Code

ShortsignatureCode
Control0..1
TypeCWE
102. IN1.signatureCodeDate
Definition

Signature Code Date

ShortsignatureCodeDate
Control0..1
TypeDT
104. IN1.insuredsBirthPlace
Definition

Insured's Birth Place

ShortinsuredsBirthPlace
Control0..1
TypeST
106. IN1.vIPIndicator
Definition

VIP Indicator

ShortvIPIndicator
Control0..1
TypeCWE
108. IN1.externalHealthPlanIdentifiers
Definition

External Health Plan Identifiers

ShortexternalHealthPlanIdentifiers
Control0..*
TypeCX
110. IN1.insuranceActionCode
Definition

Insurance Action Code

ShortinsuranceActionCode
Control0..1
TypeID

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

0. IN1
Definition

Insurance


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. IN1.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. IN1.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. IN1.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 IN1.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. IN1.setID-IN1
Definition

Set ID - IN1

ShortsetID-IN1
Control1..1
TypeSI
Must Supporttrue
Max Length4
10. IN1.healthPlanID
Definition

Health Plan ID

ShorthealthPlanID
Control1..1
TypeCWE
Must Supporttrue
12. IN1.insuranceCompanyID
Definition

Insurance Company ID

ShortinsuranceCompanyID
Control1..*
TypeCX
Must Supporttrue
14. IN1.insuranceCompanyName
Definition

Insurance Company Name

ShortinsuranceCompanyName
Control0..*
TypeXON
16. IN1.insuranceCompanyAddress
Definition

Insurance Company Address

ShortinsuranceCompanyAddress
Control0..*
TypeXAD
18. IN1.insuranceCoContactPerson
Definition

Insurance Co Contact Person

ShortinsuranceCoContactPerson
Control0..*
TypeXPN
20. IN1.insuranceCoPhoneNumber
Definition

Insurance Co Phone Number

ShortinsuranceCoPhoneNumber
Control0..*
TypeXTN
22. IN1.groupNumber
Definition

Group Number

ShortgroupNumber
Control0..1
TypeST
24. IN1.groupName
Definition

Group Name

ShortgroupName
Control0..*
TypeXON
26. IN1.insuredsGroupEmpID
Definition

Insured's Group Emp ID

ShortinsuredsGroupEmpID
Control0..*
TypeCX
28. IN1.insuredsGroupEmpName
Definition

Insured's Group Emp Name

ShortinsuredsGroupEmpName
Control0..*
TypeXON
30. IN1.planEffectiveDate
Definition

Plan Effective Date

ShortplanEffectiveDate
Control0..1
TypeDT
32. IN1.planExpirationDate
Definition

Plan Expiration Date

ShortplanExpirationDate
Control0..1
TypeDT
34. IN1.authorizationInformation
Definition

Authorization Information

ShortauthorizationInformation
Control0..1
TypeAUI
36. IN1.planType
Definition

Plan Type

ShortplanType
Control0..1
TypeCWE
38. IN1.nameOfInsured
Definition

Name Of Insured

ShortnameOfInsured
Control0..*
TypeXPN
40. IN1.insuredsRelationshipToPatient
Definition

Insured's Relationship To Patient

ShortinsuredsRelationshipToPatient
Control0..1
TypeCWE
42. IN1.insuredsDateOfBirth
Definition

Insured's Date Of Birth

ShortinsuredsDateOfBirth
Control0..1
TypeDTM
44. IN1.insuredsAddress
Definition

Insured's Address

ShortinsuredsAddress
Control0..*
TypeXAD
46. IN1.assignmentOfBenefits
Definition

Assignment Of Benefits

ShortassignmentOfBenefits
Control0..1
TypeCWE
48. IN1.coordinationOfBenefits
Definition

Coordination Of Benefits

ShortcoordinationOfBenefits
Control0..1
TypeCWE
50. IN1.coordOfBenPriority
Definition

Coord Of Ben. Priority

ShortcoordOfBenPriority
Control0..1
TypeST
52. IN1.noticeOfAdmissionFlag
Definition

Notice Of Admission Flag

ShortnoticeOfAdmissionFlag
Control0..1
TypeID
Max Length1
54. IN1.noticeOfAdmissionDate
Definition

Notice Of Admission Date

ShortnoticeOfAdmissionDate
Control0..1
TypeDT
56. IN1.reportOfEligibilityFlag
Definition

Report Of Eligibility Flag

ShortreportOfEligibilityFlag
Control0..1
TypeID
Max Length1
58. IN1.reportOfEligibilityDate
Definition

Report Of Eligibility Date

ShortreportOfEligibilityDate
Control0..1
TypeDT
60. IN1.releaseInformationCode
Definition

Release Information Code

ShortreleaseInformationCode
Control0..1
TypeCWE
62. IN1.pre-AdmitCertPAC
Definition

Pre-Admit Cert (PAC)

Shortpre-AdmitCertPAC
Control0..1
TypeST
64. IN1.verificationDateTime
Definition

Verification DateTime

ShortverificationDateTime
Control0..1
TypeDTM
66. IN1.verificationBy
Definition

Verification By

ShortverificationBy
Control0..*
TypeXCN
68. IN1.typeOfAgreementCode
Definition

Type Of Agreement Code

ShorttypeOfAgreementCode
Control0..1
TypeCWE
70. IN1.billingStatus
Definition

Billing Status

ShortbillingStatus
Control0..1
TypeCWE
72. IN1.lifetimeReserveDays
Definition

Lifetime Reserve Days

ShortlifetimeReserveDays
Control0..1
TypeNM
74. IN1.delayBeforeLRDay
Definition

Delay Before L.R. Day

ShortdelayBeforeLRDay
Control0..1
TypeNM
76. IN1.companyPlanCode
Definition

Company Plan Code

ShortcompanyPlanCode
Control0..1
TypeCWE
78. IN1.policyNumber
Definition

Policy Number

ShortpolicyNumber
Control0..1
TypeST
80. IN1.policyDeductible
Definition

Policy Deductible

ShortpolicyDeductible
Control0..1
TypeCP
82. IN1.policyLimit-Amount
Definition

Policy Limit - Amount

ShortpolicyLimit-Amount
Control0..1
Type-
84. IN1.policyLimit-Days
Definition

Policy Limit - Days

ShortpolicyLimit-Days
Control0..1
TypeNM
86. IN1.roomRate-Semi-Private
Definition

Room Rate - Semi-Private

ShortroomRate-Semi-Private
Control0..1
Type-
88. IN1.roomRate-Private
Definition

Room Rate - Private

ShortroomRate-Private
Control0..1
Type-
90. IN1.insuredsEmploymentStatus
Definition

Insured's Employment Status

ShortinsuredsEmploymentStatus
Control0..1
TypeCWE
92. IN1.insuredsAdministrativeSex
Definition

Insured's Administrative Sex

ShortinsuredsAdministrativeSex
Control0..1
TypeCWE
94. IN1.insuredsEmployersAddress
Definition

Insured's Employer's Address

ShortinsuredsEmployersAddress
Control0..*
TypeXAD
96. IN1.verificationStatus
Definition

Verification Status

ShortverificationStatus
Control0..1
TypeST
98. IN1.priorInsurancePlanID
Definition

Prior Insurance Plan ID

ShortpriorInsurancePlanID
Control0..1
TypeCWE
100. IN1.coverageType
Definition

Coverage Type

ShortcoverageType
Control0..1
TypeCWE
102. IN1.handicap
Definition

Handicap

Shorthandicap
Control0..1
TypeCWE
104. IN1.insuredsIDNumber
Definition

Insured's ID Number

ShortinsuredsIDNumber
Control0..*
TypeCX
106. IN1.signatureCode
Definition

Signature Code

ShortsignatureCode
Control0..1
TypeCWE
108. IN1.signatureCodeDate
Definition

Signature Code Date

ShortsignatureCodeDate
Control0..1
TypeDT
110. IN1.insuredsBirthPlace
Definition

Insured's Birth Place

ShortinsuredsBirthPlace
Control0..1
TypeST
112. IN1.vIPIndicator
Definition

VIP Indicator

ShortvIPIndicator
Control0..1
TypeCWE
114. IN1.externalHealthPlanIdentifiers
Definition

External Health Plan Identifiers

ShortexternalHealthPlanIdentifiers
Control0..*
TypeCX
116. IN1.insuranceActionCode
Definition

Insurance Action Code

ShortinsuranceActionCode
Control0..1
TypeID

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

0. IN1
Definition

Insurance

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. IN1.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. IN1.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. IN1.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. IN1.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. IN1.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. IN1.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. IN1.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 IN1.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. IN1.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 IN1.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. IN1.setID-IN1
Definition

Set ID - IN1

ShortsetID-IN1
Control1..1
TypeSI
Must Supporttrue
Max Length4
20. IN1.healthPlanID
Definition

Health Plan ID

ShorthealthPlanID
Control1..1
TypeCWE
Must Supporttrue
22. IN1.insuranceCompanyID
Definition

Insurance Company ID

ShortinsuranceCompanyID
Control1..*
TypeCX
Must Supporttrue
24. IN1.insuranceCompanyName
Definition

Insurance Company Name

ShortinsuranceCompanyName
Control0..*
TypeXON
26. IN1.insuranceCompanyAddress
Definition

Insurance Company Address

ShortinsuranceCompanyAddress
Control0..*
TypeXAD
28. IN1.insuranceCoContactPerson
Definition

Insurance Co Contact Person

ShortinsuranceCoContactPerson
Control0..*
TypeXPN
30. IN1.insuranceCoPhoneNumber
Definition

Insurance Co Phone Number

ShortinsuranceCoPhoneNumber
Control0..*
TypeXTN
32. IN1.groupNumber
Definition

Group Number

ShortgroupNumber
Control0..1
TypeST
34. IN1.groupName
Definition

Group Name

ShortgroupName
Control0..*
TypeXON
36. IN1.insuredsGroupEmpID
Definition

Insured's Group Emp ID

ShortinsuredsGroupEmpID
Control0..*
TypeCX
38. IN1.insuredsGroupEmpName
Definition

Insured's Group Emp Name

ShortinsuredsGroupEmpName
Control0..*
TypeXON
40. IN1.planEffectiveDate
Definition

Plan Effective Date

ShortplanEffectiveDate
Control0..1
TypeDT
42. IN1.planExpirationDate
Definition

Plan Expiration Date

ShortplanExpirationDate
Control0..1
TypeDT
44. IN1.authorizationInformation
Definition

Authorization Information

ShortauthorizationInformation
Control0..1
TypeAUI
46. IN1.planType
Definition

Plan Type

ShortplanType
Control0..1
TypeCWE
48. IN1.nameOfInsured
Definition

Name Of Insured

ShortnameOfInsured
Control0..*
TypeXPN
50. IN1.insuredsRelationshipToPatient
Definition

Insured's Relationship To Patient

ShortinsuredsRelationshipToPatient
Control0..1
TypeCWE
52. IN1.insuredsDateOfBirth
Definition

Insured's Date Of Birth

ShortinsuredsDateOfBirth
Control0..1
TypeDTM
54. IN1.insuredsAddress
Definition

Insured's Address

ShortinsuredsAddress
Control0..*
TypeXAD
56. IN1.assignmentOfBenefits
Definition

Assignment Of Benefits

ShortassignmentOfBenefits
Control0..1
TypeCWE
58. IN1.coordinationOfBenefits
Definition

Coordination Of Benefits

ShortcoordinationOfBenefits
Control0..1
TypeCWE
60. IN1.coordOfBenPriority
Definition

Coord Of Ben. Priority

ShortcoordOfBenPriority
Control0..1
TypeST
62. IN1.noticeOfAdmissionFlag
Definition

Notice Of Admission Flag

ShortnoticeOfAdmissionFlag
Control0..1
TypeID
Max Length1
64. IN1.noticeOfAdmissionDate
Definition

Notice Of Admission Date

ShortnoticeOfAdmissionDate
Control0..1
TypeDT
66. IN1.reportOfEligibilityFlag
Definition

Report Of Eligibility Flag

ShortreportOfEligibilityFlag
Control0..1
TypeID
Max Length1
68. IN1.reportOfEligibilityDate
Definition

Report Of Eligibility Date

ShortreportOfEligibilityDate
Control0..1
TypeDT
70. IN1.releaseInformationCode
Definition

Release Information Code

ShortreleaseInformationCode
Control0..1
TypeCWE
72. IN1.pre-AdmitCertPAC
Definition

Pre-Admit Cert (PAC)

Shortpre-AdmitCertPAC
Control0..1
TypeST
74. IN1.verificationDateTime
Definition

Verification DateTime

ShortverificationDateTime
Control0..1
TypeDTM
76. IN1.verificationBy
Definition

Verification By

ShortverificationBy
Control0..*
TypeXCN
78. IN1.typeOfAgreementCode
Definition

Type Of Agreement Code

ShorttypeOfAgreementCode
Control0..1
TypeCWE
80. IN1.billingStatus
Definition

Billing Status

ShortbillingStatus
Control0..1
TypeCWE
82. IN1.lifetimeReserveDays
Definition

Lifetime Reserve Days

ShortlifetimeReserveDays
Control0..1
TypeNM
84. IN1.delayBeforeLRDay
Definition

Delay Before L.R. Day

ShortdelayBeforeLRDay
Control0..1
TypeNM
86. IN1.companyPlanCode
Definition

Company Plan Code

ShortcompanyPlanCode
Control0..1
TypeCWE
88. IN1.policyNumber
Definition

Policy Number

ShortpolicyNumber
Control0..1
TypeST
90. IN1.policyDeductible
Definition

Policy Deductible

ShortpolicyDeductible
Control0..1
TypeCP
92. IN1.policyLimit-Amount
Definition

Policy Limit - Amount

ShortpolicyLimit-Amount
Control0..1
Type-
94. IN1.policyLimit-Days
Definition

Policy Limit - Days

ShortpolicyLimit-Days
Control0..1
TypeNM
96. IN1.roomRate-Semi-Private
Definition

Room Rate - Semi-Private

ShortroomRate-Semi-Private
Control0..1
Type-
98. IN1.roomRate-Private
Definition

Room Rate - Private

ShortroomRate-Private
Control0..1
Type-
100. IN1.insuredsEmploymentStatus
Definition

Insured's Employment Status

ShortinsuredsEmploymentStatus
Control0..1
TypeCWE
102. IN1.insuredsAdministrativeSex
Definition

Insured's Administrative Sex

ShortinsuredsAdministrativeSex
Control0..1
TypeCWE
104. IN1.insuredsEmployersAddress
Definition

Insured's Employer's Address

ShortinsuredsEmployersAddress
Control0..*
TypeXAD
106. IN1.verificationStatus
Definition

Verification Status

ShortverificationStatus
Control0..1
TypeST
108. IN1.priorInsurancePlanID
Definition

Prior Insurance Plan ID

ShortpriorInsurancePlanID
Control0..1
TypeCWE
110. IN1.coverageType
Definition

Coverage Type

ShortcoverageType
Control0..1
TypeCWE
112. IN1.handicap
Definition

Handicap

Shorthandicap
Control0..1
TypeCWE
114. IN1.insuredsIDNumber
Definition

Insured's ID Number

ShortinsuredsIDNumber
Control0..*
TypeCX
116. IN1.signatureCode
Definition

Signature Code

ShortsignatureCode
Control0..1
TypeCWE
118. IN1.signatureCodeDate
Definition

Signature Code Date

ShortsignatureCodeDate
Control0..1
TypeDT
120. IN1.insuredsBirthPlace
Definition

Insured's Birth Place

ShortinsuredsBirthPlace
Control0..1
TypeST
122. IN1.vIPIndicator
Definition

VIP Indicator

ShortvIPIndicator
Control0..1
TypeCWE
124. IN1.externalHealthPlanIdentifiers
Definition

External Health Plan Identifiers

ShortexternalHealthPlanIdentifiers
Control0..*
TypeCX
126. IN1.insuranceActionCode
Definition

Insurance Action Code

ShortinsuranceActionCode
Control0..1
TypeID