NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Resource Profile: PH_Coverage - Detailed Descriptions

Page standards status: Draft

Definitions for the PH-Coverage resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Coverage
Definition | Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Short | Insurance or medical plan or a payment agreement
Comments | The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-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().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: 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. Coverage.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.
Short | A 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 it's narrative along with other profiles, value sets, etc.
Control | 0..01
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Coverage.language
Definition | The base language in which the resource is written.
Short | Language 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).
Control | 0..01
Binding | The codes SHOULD be taken from CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Coverage.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.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have 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.
Control | 0..01
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Coverage.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, 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.
Control | 0..0*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
10. Coverage.extension
Definition | An Extension 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 manageable, 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.
Short | ExtensionAdditional 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.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
12. Coverage.modifierExtension
Definition | An Extension 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 manageable, 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).
Short | ExtensionExtensions 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.
Control | 0..0*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-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())
14. Coverage.status
Definition | The status of the resource instance.
Short | active | cancelled | draft | entered-in-error
Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/fm-status|4.0.1` ) A code specifying the state of the resource instance.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Coverage.policyHolder
Definition | The party who 'owns' the insurance policy.
Short | Owner of the policy
Comments | For example: may be an individual, corporation or the subscriber's employer.
Control | 0..1
Type | Reference(PH Patient, PH RelatedPerson, PH Organization, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | true
Requirements | This provides employer information in the case of Worker's Compensation and other policies.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Coverage.subscriber
Definition | The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
Short | Subscriber to the policy
Comments | May be self or a parent in the case of dependants.
Control | 0..01
Type | Reference(Patient, RelatedPerson)
Is Modifier | false
Summary | true
Requirements | This is the party who is entitled to the benfits under the policy.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Coverage.subscriberId
Definition | The insurer assigned ID for the Subscriber.
Short | ID assigned to the subscriber
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The insurer requires this identifier on correspondance and claims (digital and otherwise).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Coverage.beneficiary
Definition | The party who benefits from the insurance coverage; the patient when products and/or services are provided.
Short | Plan beneficiary
Control | 1..1
Type | Reference(PH Patient, Patient)
Is Modifier | false
Summary | true
Requirements | This is the party who receives treatment for which the costs are reimbursed under the coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Coverage.dependent
Definition | A unique identifier for a dependent under the coverage.
Short | Dependent number
Comments | Periodically the member number is constructed from the subscriberId and the dependant number.
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Coverage.relationship
Definition | The relationship of beneficiary (patient) to the subscriber.
Short | Beneficiary relationship to the subscriber
Comments | Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.
Control | 0..01
Binding | Unless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1` ) The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To determine relationship between the patient and the subscriber to determine coordination of benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Coverage.period
Definition | Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
Short | Coverage start and end dates
Control | 0..01
Type | Period
Is Modifier | false
Summary | true
Requirements | Some insurers require the submission of the coverage term.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Coverage.payor
Definition | The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
Short | Issuer of the policy
Comments | May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.
Control | 1..*
Type | Reference(PH Organization, PH Patient, Organization, Patient, RelatedPerson)
Is Modifier | false
Summary | true
Requirements | Need to identify the issuer to target for claim processing and for coordination of benefit processing.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Coverage.class
Definition | A suite of underwriter specific classifiers.
Short | Additional coverage classifications
Comments | For example may be used to identify a class of coverage or employer group, Policy, Plan.
Control | 0..0*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The codes provided on the health card which identify or confirm the specific policy for the insurer.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
37. Coverage.order
Definition | The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
Short | Relative order of the coverage
Control | 0..01
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Used in managing the coordination of benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
39. Coverage.network
Definition | The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
Short | Insurer network
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Used in referral for treatment and in claims processing.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
41. Coverage.subrogation
Definition | When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
Short | Reimbursement to insurer
Comments | Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
Control | 0..01
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | See definition for when to be used.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
43. Coverage.contract
Definition | The policy(s) which constitute this insurance coverage.
Short | Contract details
Control | 0..0*
Type | Reference(Contract)
Is Modifier | false
Summary | false
Requirements | To reference the legally binding contract between the policy holder and the insurer.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Coverage
2. Coverage.meta
4. Coverage.meta.extension:hfRecordedDate
Slice Name | hfRecordedDate
Control | 0..1
Type | Extension(The recorded date indicating when the record was uploaded by the health facility.) (Extension Type: dateTime)
6. Coverage.meta.extension:hfLastUpdated
Slice Name | hfLastUpdated
Control | 0..*
Type | Extension(The date indicating when the record was last updated by the health facility.) (Extension Type: dateTime)
8. Coverage.meta.lastUpdated
Short | When the resource was uploaded to the NHDR.
10. Coverage.implicitRules
Control | 0..0
12. Coverage.language
Control | 0..0
14. Coverage.text
Control | 0..0
16. Coverage.contained
Control | 0..0
18. Coverage.extension
Control | 0..0
20. Coverage.modifierExtension
Control | 0..0
22. Coverage.policyHolder
Type | Reference(PH Patient, PH RelatedPerson, PH Organization)
24. Coverage.subscriber
Control | 0..0
26. Coverage.subscriberId
Control | 0..0
28. Coverage.beneficiary
Type | Reference(PH Patient)
30. Coverage.dependent
Control | 0..0
32. Coverage.relationship
Control | 0..0
34. Coverage.period
Control | 0..0
36. Coverage.payor
Type | Reference(PH Organization, PH Patient)
38. Coverage.class
Control | 0..0
40. Coverage.order
Control | 0..0
42. Coverage.network
Control | 0..0
44. Coverage.costToBeneficiary
46. Coverage.costToBeneficiary.id
Control | 0..0
48. Coverage.costToBeneficiary.extension
Control | 0..0
50. Coverage.costToBeneficiary.modifierExtension
Control | 0..0
52. Coverage.costToBeneficiary.type
Binding | The codes SHALL be taken from Coverage Copay Type (required to `https://nhdr.gov.ph/fhir/ValueSet/CoverageCoPayTypeVS` )
54. Coverage.costToBeneficiary.value[x]
Type | Money, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
56. Coverage.costToBeneficiary.exception
Control | 0..0
58. Coverage.subrogation
Control | 0..0
60. Coverage.contract
Control | 0..0

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

0. Coverage
Definition | Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Short | Insurance or medical plan or a payment agreement
Comments | The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-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().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: 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. Coverage.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Coverage.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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Coverage.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Coverage.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `Coverage.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Coverage.meta.extension:hfRecordedDate
Slice Name | hfRecordedDate
Definition | The recorded date indicating when the record was uploaded by the health facility.
Short | The recorded date indicating when the record was uploaded by the health facility.
Control | 0..1
Type | Extension(The recorded date indicating when the record was uploaded by the health facility.) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-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()`)
12. Coverage.meta.extension:hfLastUpdated
Slice Name | hfLastUpdated
Definition | The date indicating when the record was last updated by the health facility.
Short | The date indicating when the record was last updated by the health facility.
Control | 0..*
Type | Extension(The date indicating when the record was last updated by the health facility.) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-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()`)
14. Coverage.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Coverage.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource was uploaded to the NHDR.
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Coverage.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Coverage.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 0..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Coverage.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Coverage.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Coverage.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.
Short | A 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 it's narrative along with other profiles, value sets, etc.
Control | 0..0
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Coverage.language
Definition | The base language in which the resource is written.
Short | Language 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).
Control | 0..0
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Coverage.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.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have 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.
Control | 0..0
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Coverage.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, 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.
Control | 0..0
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
34. Coverage.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-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()`)
36. Coverage.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Invariants | ele-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()`)
38. Coverage.identifier
Definition | A unique identifier assigned to this coverage.
Short | Business Identifier for the coverage
Comments | The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows coverages to be distinguished and referenced.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Coverage.status
Definition | The status of the resource instance.
Short | active | cancelled | draft | entered-in-error
Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from FinancialResourceStatusCodes (required to `http://hl7.org/fhir/ValueSet/fm-status|4.0.1` ) A code specifying the state of the resource instance.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Coverage.type
Definition | The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
Short | Coverage category such as medical or accident
Control | 0..1
Binding | The codes SHOULD be taken from CoverageTypeAndSelf-PayCodes (preferred to `http://hl7.org/fhir/ValueSet/coverage-type|4.0.1` ) The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | The order of application of coverages is dependent on the types of coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Coverage.policyHolder
Definition | The party who 'owns' the insurance policy.
Short | Owner of the policy
Comments | For example: may be an individual, corporation or the subscriber's employer.
Control | 0..1
Type | Reference(PH Patient, PH RelatedPerson, PH Organization)
Is Modifier | false
Summary | true
Requirements | This provides employer information in the case of Worker's Compensation and other policies.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Coverage.subscriber
Definition | The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
Short | Subscriber to the policy
Comments | May be self or a parent in the case of dependants.
Control | 0..0
Type | Reference(Patient, RelatedPerson)
Is Modifier | false
Summary | true
Requirements | This is the party who is entitled to the benfits under the policy.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Coverage.subscriberId
Definition | The insurer assigned ID for the Subscriber.
Short | ID assigned to the subscriber
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The insurer requires this identifier on correspondance and claims (digital and otherwise).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Coverage.beneficiary
Definition | The party who benefits from the insurance coverage; the patient when products and/or services are provided.
Short | Plan beneficiary
Control | 1..1
Type | Reference(PH Patient)
Is Modifier | false
Summary | true
Requirements | This is the party who receives treatment for which the costs are reimbursed under the coverage.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Coverage.dependent
Definition | A unique identifier for a dependent under the coverage.
Short | Dependent number
Comments | Periodically the member number is constructed from the subscriberId and the dependant number.
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Coverage.relationship
Definition | The relationship of beneficiary (patient) to the subscriber.
Short | Beneficiary relationship to the subscriber
Comments | Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.
Control | 0..0
Binding | Unless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes (extensible to `http://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1` ) The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | To determine relationship between the patient and the subscriber to determine coordination of benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Coverage.period
Definition | Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
Short | Coverage start and end dates
Control | 0..0
Type | Period
Is Modifier | false
Summary | true
Requirements | Some insurers require the submission of the coverage term.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Coverage.payor
Definition | The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
Short | Issuer of the policy
Comments | May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.
Control | 1..*
Type | Reference(PH Organization, PH Patient)
Is Modifier | false
Summary | true
Requirements | Need to identify the issuer to target for claim processing and for coordination of benefit processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Coverage.class
Definition | A suite of underwriter specific classifiers.
Short | Additional coverage classifications
Comments | For example may be used to identify a class of coverage or employer group, Policy, Plan.
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | The codes provided on the health card which identify or confirm the specific policy for the insurer.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Coverage.order
Definition | The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
Short | Relative order of the coverage
Control | 0..0
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Used in managing the coordination of benefits.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Coverage.network
Definition | The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
Short | Insurer network
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Used in referral for treatment and in claims processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Coverage.costToBeneficiary
Definition | A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
Short | Patient payments for services/products
Comments | For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Required by providers to manage financial transaction with the patient.
Alternate Names | CoPay, Deductible, Exceptions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Coverage.costToBeneficiary.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. Coverage.costToBeneficiary.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-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()`)
78. Coverage.costToBeneficiary.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-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()`)
80. Coverage.costToBeneficiary.type
Definition | The category of patient centric costs associated with treatment.
Short | Cost category
Comments | For example visit, specialist visits, emergency, inpatient care, etc.
Control | 0..1
Binding | The codes SHALL be taken from Coverage Copay Type (required to `https://nhdr.gov.ph/fhir/ValueSet/CoverageCoPayTypeVS` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Needed to identify the category associated with the amount for the patient.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Coverage.costToBeneficiary.value[x]
Definition | The amount due from the patient for the cost category.
Short | The amount or percentage due from the beneficiary
Comments | Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
Control | 1..1
Type | Money
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Needed to identify the amount for the patient associated with the category.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Coverage.costToBeneficiary.exception
Definition | A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
Short | Exceptions for patient payments
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Required by providers to manage financial transaction with the patient.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
91. Coverage.subrogation
Definition | When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
Short | Reimbursement to insurer
Comments | Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
Control | 0..0
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | See definition for when to be used.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
93. Coverage.contract
Definition | The policy(s) which constitute this insurance coverage.
Short | Contract details
Control | 0..0
Type | Reference(Contract)
Is Modifier | false
Summary | false
Requirements | To reference the legally binding contract between the policy holder and the insurer.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)