Da Vinci Unsolicited Notifications
1.0.0 - STU1 Release

This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ADTNotificationCoverageProfile

Defining URL:http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-coverage
Version:1.0.0
Name:ADTNotificationCoverageProfile
Title:Da Vinci Admit/Transfer/Discharge Notification Coverage Profile
Status:Active as of 2020-08-24
Definition:

The Da Vinci Admit/Transfer/Discharge Notification Coverage Profile is based on the HRex Coverage Profile and constrains the Patient resource referenced by the Coverage.beneficiary element to be found in the same message Bundle.

Publisher:HL7 International - Infrastructure and Messaging Work Group
Copyright:

Used by permission of HL7 International - Infrastructure and Messaging Work Group, all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-coverage

Introduction

The Da Vinci Admit/Transfer/Discharge Notification Coverage Profile is based on the HRex Coverage Profile and constrains the Patient resource referenced by the Coverage.beneficiary element to be found in the same message Bundle.

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e., data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Coverage must have:

  1. A beneficiary
  2. A reference to a payor

Each Coverage must support:

  1. A business identifier
  2. A subscriber id

Additional Profile specific implementation guidance:

  • Note that for the admission/transfer/discharge scenario, the Coverage.beneficiary is a “reverse link” to the Patient resource and cannot be traversed from the MessageHeader within the Message Bundle. There is no mechanism to enforce profiles in a message on a reverse link except via GraphDefinition.
  • The Coverage.payor references the HRex Organization Profile profile to mandate an identifier and support additional identifier types.

Examples

The following example of this profile is a freestanding resource instance which is technically invalid since the profile is defined to reference other resources within the same Da Vinci Notification Message Bundle. For examples of this profile within a bundle, see the message bundle examples which are listed on the Examples page.

Formal Views of Profile Content

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

This structure is derived from HRexCoverage

Summary

Structures

This structure refers to these other structures:

This structure is derived from HRexCoverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*HRexCoverageInsurance or medical plan or a payment agreement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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..*IdentifierAlso known as Member identifier
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred)
... policyHolder Σ0..1Reference(US Core Patient Profile | HRex Organization Profile | RelatedPerson)Owner of the policy
... subscriber Σ0..1Reference(US Core Patient Profile)Subscriber to the policy
... subscriberId SΣ0..1stringSubscriber ID
... beneficiary SΣ1..1Reference(US Core Patient Profile) {b}Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(HRex Organization Profile)Issuer of the policy
... class 0..*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)
.... 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)
.... 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)
..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*HRexCoverageInsurance or medical plan or a payment agreement
... identifier Σ0..*IdentifierAlso known as Member identifier
... subscriberId Σ0..1stringSubscriber ID
... beneficiary Σ1..1Reference(US Core Patient Profile) {b}Plan beneficiary
... payor Σ1..*Reference(HRex Organization Profile)Issuer of the policy

doco Documentation for this format

This structure is derived from HRexCoverage

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from HRexCoverage

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*HRexCoverageInsurance or medical plan or a payment agreement
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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..*IdentifierAlso known as Member identifier
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required)
... type Σ0..1CodeableConceptCoverage category such as medical or accident
Binding: CoverageTypeAndSelf-PayCodes (preferred)
... policyHolder Σ0..1Reference(US Core Patient Profile | HRex Organization Profile | RelatedPerson)Owner of the policy
... subscriber Σ0..1Reference(US Core Patient Profile)Subscriber to the policy
... subscriberId SΣ0..1stringSubscriber ID
... beneficiary SΣ1..1Reference(US Core Patient Profile) {b}Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible)
... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(HRex Organization Profile)Issuer of the policy
... class 0..*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)
.... 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)
.... 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)
..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

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