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: UB2 (Segment) ( Experimental )

Official URL: http://hl7.org/fhir/StructureDefinition/UB2 Version: 2.9
Draft as of 2023-08-09 Responsible: FO Computable Name: UB2

Copyright/Legal: FO

Uniform Billing Data 2

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... setID-UB2 0..1SIsetID-UB2
Max Length: 4
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... coveredDays7 0..1STcoveredDays7
Max Length: 3
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorUB2If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorUB2If 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-4errorUB2If 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-5errorUB2If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceUB2A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-UB2 0..1SIsetID-UB2
Max Length: 4
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... coveredDays7 0..1STcoveredDays7
Max Length: 3
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
UB2.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorUB2If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorUB2If 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-4errorUB2If 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-5errorUB2If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceUB2A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... setID-UB2 0..1SIsetID-UB2
Max Length: 4
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... coveredDays7 0..1STcoveredDays7
Max Length: 3
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorUB2If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorUB2If 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-4errorUB2If 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-5errorUB2If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceUB2A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. UB2 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-UB2 0..1SIsetID-UB2
Max Length: 4
... co-InsuranceDays9 0..1STco-InsuranceDays9
Max Length: 3
... conditionCode24-30 0..*CWEconditionCode24-30
... coveredDays7 0..1STcoveredDays7
Max Length: 3
... non-CoveredDays8 0..1STnon-CoveredDays8
Max Length: 4
... valueAmountCode39-41 0..*UVCvalueAmountCode39-41
... occurrenceCodeDate32-35 0..*OCDoccurrenceCodeDate32-35
... occurrenceSpanCodeDates36 0..*OSPoccurrenceSpanCodeDates36
... uniformBillingLocator2state 0..*STuniformBillingLocator2state

Max Length: 29
... uniformBillingLocator11state 0..*STuniformBillingLocator11state

Max Length: 12
... uniformBillingLocator31national 0..1STuniformBillingLocator31national
Max Length: 5
... documentControlNumber 0..*STdocumentControlNumber

Max Length: 23
... uniformBillingLocator49national 0..*STuniformBillingLocator49national

Max Length: 4
... uniformBillingLocator56state 0..*STuniformBillingLocator56state

Max Length: 14
... uniformBillingLocator57sational 0..1STuniformBillingLocator57sational
Max Length: 27
... uniformBillingLocator78state 0..*STuniformBillingLocator78state

Max Length: 2
... specialVisitCount 0..1NMspecialVisitCount
Max Length: 3

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
UB2.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorUB2If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorUB2If 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-4errorUB2If 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-5errorUB2If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceUB2A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

 

Other representations of profile: CSV, Excel