Vital Records Birth and Fetal Death Reporting
1.0.0 - STU 1
Vital Records Birth and Fetal Death Reporting
1.0.0 - STU 1
This page is part of the Vital Records Birth and Fetal Death Reporting (v1.0.0: STU 1 on FHIR R4) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Defining URL: | http://hl7.org/fhir/us/bfdr/StructureDefinition/Coverage-principal-payer-for-delivery |
| Version: | 1.0.0 |
| Name: | CoveragePrincipalPayerDelivery |
| Title: | Coverage - Principal Payer for Delivery |
| Status: | Active as of 2021-10-22T14:57:04+00:00 |
| Definition: | This Coverage profile represents the principal payer for this delivery. |
| Publisher: | HL7 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/bfdr/StructureDefinition/Coverage-principal-payer-for-delivery
This concept is mapped to:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coverage
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
  type | S | 1..1 | CodeableConcept | The value set contains the list of values used to indicate the principle source of payment for the labor and delivery. Binding: Birth and Fetal Death Financial Class (NCHS) (required): Birth and Fetal Death Financial Class (NCHS) |
 payor | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for the coverage |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| type | SΣ | 1..1 | CodeableConcept | The value set contains the list of values used to indicate the principle source of payment for the labor and delivery. Binding: Birth and Fetal Death Financial Class (NCHS) (required): Birth and Fetal Death Financial Class (NCHS) |
 policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy |
| subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
| subscriberId | Σ | 0..1 | string | ID assigned to the subscriber |
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary |
| dependent | Σ | 0..1 | string | Dependent number |
| relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |
| period | Σ | 0..1 | Period | Coverage start and end dates |
 payor | Σ | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| class | 0..* | BackboneElement | Additional coverage classifications | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
| value | Σ | 1..1 | string | Value associated with the type |
| name | Σ | 0..1 | string | Human readable description of the type and value |
| order | Σ | 0..1 | positiveInt | Relative order of the coverage |
| network | Σ | 0..1 | string | Insurer network |
| costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. |
 value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |
| valueQuantity | Quantity(SimpleQuantity) | |||
| valueMoney | Money | |||
| exception | 0..* | BackboneElement | Exceptions for patient payments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. |
| period | Σ | 0..1 | Period | The effective period of the exception |
| subrogation | 0..1 | boolean | Reimbursement to insurer | |
| contract | 0..* | Reference(Contract) | Contract details | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
| type | Σ | 1..1 | CodeableConcept | The value set contains the list of values used to indicate the principle source of payment for the labor and delivery. Binding: Birth and Fetal Death Financial Class (NCHS) (required): Birth and Fetal Death Financial Class (NCHS) |
| payor | Σ | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
| data-absent-reason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| Documentation for this format | ||||
This structure is derived from Coverage
Differential View
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
| type | S | 1..1 | CodeableConcept | The value set contains the list of values used to indicate the principle source of payment for the labor and delivery. Binding: Birth and Fetal Death Financial Class (NCHS) (required): Birth and Fetal Death Financial Class (NCHS) |
| payor | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Coverage | 0..* | Coverage | Insurance or medical plan or a payment agreement | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for the coverage |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| type | SΣ | 1..1 | CodeableConcept | The value set contains the list of values used to indicate the principle source of payment for the labor and delivery. Binding: Birth and Fetal Death Financial Class (NCHS) (required): Birth and Fetal Death Financial Class (NCHS) |
| policyHolder | Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy |
| subscriber | Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy |
| subscriberId | Σ | 0..1 | string | ID assigned to the subscriber |
| beneficiary | Σ | 1..1 | Reference(Patient) | Plan beneficiary |
| dependent | Σ | 0..1 | string | Dependent number |
| relationship | 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |
| period | Σ | 0..1 | Period | Coverage start and end dates |
| payor | Σ | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| data-absent-reason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| class | 0..* | BackboneElement | Additional coverage classifications | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
| value | Σ | 1..1 | string | Value associated with the type |
| name | Σ | 0..1 | string | Human readable description of the type and value |
| order | Σ | 0..1 | positiveInt | Relative order of the coverage |
| network | Σ | 0..1 | string | Insurer network |
| costToBeneficiary | 0..* | BackboneElement | Patient payments for services/products | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. |
| value[x] | Σ | 1..1 | The amount or percentage due from the beneficiary | |
| valueQuantity | Quantity(SimpleQuantity) | |||
| valueMoney | Money | |||
| exception | 0..* | BackboneElement | Exceptions for patient payments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. |
| period | Σ | 0..1 | Period | The effective period of the exception |
| subrogation | 0..1 | boolean | Reimbursement to insurer | |
| contract | 0..* | Reference(Contract) | Contract details | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Coverage.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Coverage.status | required | FinancialResourceStatusCodes |
| Coverage.type | required | PHVS_BirthAndFetalDeathFinancialClass_NCHS |
| Coverage.relationship | extensible | SubscriberRelationshipCodes |
| Coverage.payor.type | extensible | ResourceType |
| Coverage.class.type | extensible | CoverageClassCodes |
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodes |
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodes |
| Id | Path | Details | Requirements |
| dom-2 | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Coverage | 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().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-4 | Coverage | 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 | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Coverage.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.policyHolder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subscriber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subscriberId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.beneficiary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.dependent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.payor.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.payor.extension:dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.payor.extension:dataAbsentReason | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.payor.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.payor.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.class.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.class.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.class.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.class.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.class.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.order | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.network | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.exception.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.exception.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Coverage.costToBeneficiary.exception.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Coverage.costToBeneficiary.exception.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.costToBeneficiary.exception.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.subrogation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Coverage.contract | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.bfdr#1.0.0 based on FHIR 4.0.1. Generated 2021-10-22
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change