FHIR Orders Exchange (FOE) / Post-Acute Orders (PAO) / (DME-Orders)
0.2.2 - CI Build United States of America flag

FHIR Orders Exchange (FOE) / Post-Acute Orders (PAO) / (DME-Orders), published by HL7. This is not an authorized publication; it is the continuous build for version 0.2.2). This version is based on the current content of https://github.com/HL7/dme-orders/ and changes regularly. See the Directory of published versions

Resource Profile: PAO Coverage Profile

Official URL: http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAOX-coverage Version: 0.2.2
Active as of 2023-06-25 Computable Name: PAOx_Coverage

PAO Coverage Resource Profile

Purpose

Intro

Usage:

Formal Views of Profile Content

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

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... identifier S0..*IdentifierBusiness Identifier for the coverage
... status S1..1codeactive | cancelled | draft | entered-in-error
... subscriberId S0..1stringID assigned to the subscriber
... payor S1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
... subscriberId SΣ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Patient)Plan beneficiary
... payor SΣ1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Coverage.statusrequiredFinancialResourceStatusCodes
Coverage.class.typeextensibleCoverageClassCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA 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
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId SΣ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Patient)Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type
.... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.statusrequiredFinancialResourceStatusCodes
Coverage.typepreferredCoverageTypeAndSelf-PayCodes
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes

Constraints

IdGradePath(s)DetailsRequirements
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 Coverage

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... identifier S0..*IdentifierBusiness Identifier for the coverage
... status S1..1codeactive | cancelled | draft | entered-in-error
... subscriberId S0..1stringID assigned to the subscriber
... payor S1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
... subscriberId SΣ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Patient)Plan beneficiary
... payor SΣ1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Coverage.statusrequiredFinancialResourceStatusCodes
Coverage.class.typeextensibleCoverageClassCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA 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
.. Coverage 0..*CoverageInsurance or medical plan or a payment agreement
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId SΣ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(Patient)Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(US Core Organization Profile)Issuer of the policy
... class S0..*BackboneElementAdditional coverage classifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type
.... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Coverage.statusrequiredFinancialResourceStatusCodes
Coverage.typepreferredCoverageTypeAndSelf-PayCodes
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes

Constraints

IdGradePath(s)DetailsRequirements
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 Coverage

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Notes