HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1 Portugal flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, publicado por HL7 Portugal. Este guia não é uma publicação autorizada; é a compilação contínua para a versão 1.0.0 construída pela FHIR (HL7® FHIR® Standard) CI Build. Esta versão é baseada no conteúdo atual de https://github.com/hl7-pt/patient-admin-ig/ e muda regularmente. Veja o Diretório de versões publicadas

Resource Profile: PTCoverage - Detailed Descriptions

Active as of 2025-12-18

Definitions for the Coverage-Pt resource profile.

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Coverage
Definição

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

CurtoInsurance or medical plan or a payment agreement
Comentários

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

Controlo0..*
É modificadorfalse
Resumofalse
Invariantesdom-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
Definição

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CurtoLogical id of this artifact
Comentários

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Controlo10..1
Tipoidstring
É modificadorfalse
Resumotrue
4. Coverage.implicitRules
Definição

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.

CurtoA set of rules under which this content was created
Comentários

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.

Controlo0..1
Tipouri
É modificadortrue porque 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
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Coverage.extension
Definição

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.

CurtoExtensionAdditional content defined by implementations
Comentários

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.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
SlicingEste elemento introduz um conjunto de fatias em Coverage.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 8. Coverage.extension:coverage-reason
    Nome da fatiacoverage-reason
    Definição

    An Extension

    Curtomotivo de isenção
    Controlo0..1
    Este elemento é afetado pelas seguintes invariantes: ele-1
    TipoExtension(PTCoverageReason) (Tipo de extensão: CodeableConcept)
    É modificadorfalse
    Deve apoiartrue
    Resumofalse
    Invariantesele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Coverage.modifierExtension
    Definição

    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).

    CurtoExtensions that cannot be ignored
    Comentários

    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.

    Controlo0..*
    TipoExtension
    É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Resumofalse
    Requisitos

    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.

    Nomes alternativosextensions, user content
    Invariantesele-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.status
    Definição

    The status of the resource instance.

    Curtoactive | cancelled | draft | entered-in-error
    Comentários

    This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de FinancialResourceStatusCodeshttp://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.

    Tipocode
    É modificadortrue porque 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
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Requisitos

    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'.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Coverage.type
    Definição

    The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

    CurtoCoverage category such as medical or accident
    Controlo0..1
    VínculoOs códigos DEVERÃO ser retirados de CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type|4.0.1
    (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.

    TipoCodeableConcept
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    The order of application of coverages is dependent on the types of coverage.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Coverage.beneficiary
    Definição

    The party who benefits from the insurance coverage; the patient when products and/or services are provided.

    CurtoPlan beneficiary
    Controlo1..1
    TipoReference(Patient)
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    This is the party who receives treatment for which the costs are reimbursed under the coverage.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Coverage.period
    Definição

    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.

    CurtoCoverage start and end dates
    Controlo0..1
    TipoPeriod
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    Some insurers require the submission of the coverage term.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Coverage.payor
    Definição

    The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

    CurtoIssuer of the policy
    Comentários

    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.

    Controlo1..1*
    TipoReference(Organization, Organization, Patient, RelatedPerson)
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    Need to identify the issuer to target for claim processing and for coordination of benefit processing.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

    0. Coverage
    2. Coverage.id
    Controlo1..?
    4. Coverage.extension
    SlicingEste elemento introduz um conjunto de fatias em Coverage.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 6. Coverage.extension:coverage-reason
      Nome da fatiacoverage-reason
      Controlo0..1
      TipoExtension(PTCoverageReason) (Tipo de extensão: CodeableConcept)
      Deve apoiartrue
      8. Coverage.type
      Deve apoiartrue
      10. Coverage.beneficiary
      Deve apoiartrue
      12. Coverage.period
      Deve apoiartrue
      14. Coverage.payor
      Controlo0..1
      TipoReference(Organization)
      Deve apoiartrue

      Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

      0. Coverage
      Definição

      Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

      CurtoInsurance or medical plan or a payment agreement
      Comentários

      The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

      Controlo0..*
      É modificadorfalse
      Resumofalse
      Invariantesdom-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
      Definição

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      CurtoLogical id of this artifact
      Comentários

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Controlo1..1
      Tipoid
      É modificadorfalse
      Resumotrue
      4. Coverage.meta
      Definição

      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.

      CurtoMetadata about the resource
      Controlo0..1
      TipoMeta
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Coverage.implicitRules
      Definição

      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.

      CurtoA set of rules under which this content was created
      Comentários

      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.

      Controlo0..1
      Tipouri
      É modificadortrue porque 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
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Coverage.language
      Definição

      The base language in which the resource is written.

      CurtoLanguage of the resource content
      Comentários

      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).

      Controlo0..1
      VínculoOs códigos DEVERÃO ser retirados de CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Vínculos adicionaisObjetivo
      AllLanguagesVínculo máximo
      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Coverage.text
      Definição

      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.

      CurtoText summary of the resource, for human interpretation
      Comentários

      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.

      Controlo0..1
      TipoNarrative
      É modificadorfalse
      Resumofalse
      Nomes alternativosnarrative, html, xhtml, display
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Coverage.contained
      Definição

      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.

      CurtoContained, inline Resources
      Comentários

      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.

      Controlo0..*
      TipoResource
      É modificadorfalse
      Resumofalse
      Nomes alternativosinline resources, anonymous resources, contained resources
      14. Coverage.extension
      Definição

      An Extension

      CurtoExtension
      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Invariantesele-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())
      SlicingEste elemento introduz um conjunto de fatias em Coverage.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 16. Coverage.extension:coverage-reason
        Nome da fatiacoverage-reason
        Definição

        An Extension

        Curtomotivo de isenção
        Controlo0..1
        Este elemento é afetado pelas seguintes invariantes: ele-1
        TipoExtension(PTCoverageReason) (Tipo de extensão: CodeableConcept)
        É modificadorfalse
        Deve apoiartrue
        Resumofalse
        Invariantesele-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())
        18. Coverage.modifierExtension
        Definição

        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).

        CurtoExtensions that cannot be ignored
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Resumofalse
        Requisitos

        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.

        Nomes alternativosextensions, user content
        Invariantesele-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())
        20. Coverage.identifier
        Definição

        A unique identifier assigned to this coverage.

        CurtoBusiness Identifier for the coverage
        Comentários

        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.

        NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
        Controlo0..*
        TipoIdentifier
        É modificadorfalse
        Resumotrue
        Requisitos

        Allows coverages to be distinguished and referenced.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Coverage.status
        Definição

        The status of the resource instance.

        Curtoactive | cancelled | draft | entered-in-error
        Comentários

        This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

        Controlo1..1
        VínculoOs códigos DEVERÃO ser retirados de FinancialResourceStatusCodes
        (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

        A code specifying the state of the resource instance.

        Tipocode
        É modificadortrue porque 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
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        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'.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Coverage.type
        Definição

        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

        CurtoCoverage category such as medical or accident
        Controlo0..1
        VínculoOs códigos DEVERÃO ser retirados de 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.

        TipoCodeableConcept
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        The order of application of coverages is dependent on the types of coverage.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. Coverage.policyHolder
        Definição

        The party who 'owns' the insurance policy.

        CurtoOwner of the policy
        Comentários

        For example: may be an individual, corporation or the subscriber's employer.

        Controlo0..1
        TipoReference(Patient, RelatedPerson, Organization)
        É modificadorfalse
        Resumotrue
        Requisitos

        This provides employer information in the case of Worker's Compensation and other policies.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. Coverage.subscriber
        Definição

        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.

        CurtoSubscriber to the policy
        Comentários

        May be self or a parent in the case of dependants.

        Controlo0..1
        TipoReference(Patient, RelatedPerson)
        É modificadorfalse
        Resumotrue
        Requisitos

        This is the party who is entitled to the benfits under the policy.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Coverage.subscriberId
        Definição

        The insurer assigned ID for the Subscriber.

        CurtoID assigned to the subscriber
        Controlo0..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        The insurer requires this identifier on correspondance and claims (digital and otherwise).

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Coverage.beneficiary
        Definição

        The party who benefits from the insurance coverage; the patient when products and/or services are provided.

        CurtoPlan beneficiary
        Controlo1..1
        TipoReference(Patient)
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        This is the party who receives treatment for which the costs are reimbursed under the coverage.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Coverage.dependent
        Definição

        A unique identifier for a dependent under the coverage.

        CurtoDependent number
        Comentários

        Periodically the member number is constructed from the subscriberId and the dependant number.

        Controlo0..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Coverage.relationship
        Definição

        The relationship of beneficiary (patient) to the subscriber.

        CurtoBeneficiary relationship to the subscriber
        Comentários

        Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

        Controlo0..1
        VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de 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).

        TipoCodeableConcept
        É modificadorfalse
        Resumofalse
        Requisitos

        To determine relationship between the patient and the subscriber to determine coordination of benefits.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Coverage.period
        Definição

        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.

        CurtoCoverage start and end dates
        Controlo0..1
        TipoPeriod
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        Some insurers require the submission of the coverage term.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Coverage.payor
        Definição

        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

        CurtoIssuer of the policy
        Comentários

        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.

        Controlo1..1
        TipoReference(Organization)
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        Need to identify the issuer to target for claim processing and for coordination of benefit processing.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Coverage.class
        Definição

        A suite of underwriter specific classifiers.

        CurtoAdditional coverage classifications
        Comentários

        For example may be used to identify a class of coverage or employer group, Policy, Plan.

        Controlo0..*
        TipoBackboneElement
        É modificadorfalse
        Resumofalse
        Requisitos

        The codes provided on the health card which identify or confirm the specific policy for the insurer.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Coverage.class.id
        Definição

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        CurtoUnique id for inter-element referencing
        Controlo0..1
        Tipostring
        É modificadorfalse
        Formato XMLNo formato XML, esta propriedade é representada como um atributo.
        Resumofalse
        46. Coverage.class.extension
        Definição

        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.

        CurtoAdditional content defined by implementations
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadorfalse
        Resumofalse
        Nomes alternativosextensions, user content
        Invariantesele-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())
        48. Coverage.class.modifierExtension
        Definição

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

        CurtoExtensions that cannot be ignored even if unrecognized
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Resumotrue
        Requisitos

        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.

        Nomes alternativosextensions, user content, modifiers
        Invariantesele-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())
        50. Coverage.class.type
        Definição

        The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

        CurtoType of class such as 'group' or 'plan'
        Controlo1..1
        VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de CoverageClassCodes
        (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.0.1)

        The policy classifications, eg. Group, Plan, Class, etc.

        TipoCodeableConcept
        É modificadorfalse
        Resumotrue
        Requisitos

        The insurer issued label for a specific health card value.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Coverage.class.value
        Definição

        The alphanumeric string value associated with the insurer issued label.

        CurtoValue associated with the type
        Comentários

        For example, the Group or Plan number.

        Controlo1..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        The insurer issued label and value are necessary to identify the specific policy.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Coverage.class.name
        Definição

        A short description for the class.

        CurtoHuman readable description of the type and value
        Controlo0..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        Used to provide a meaningful description in correspondence to the patient.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Coverage.order
        Definição

        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.

        CurtoRelative order of the coverage
        Controlo0..1
        TipopositiveInt
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        Used in managing the coordination of benefits.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Coverage.network
        Definição

        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.

        CurtoInsurer network
        Controlo0..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Requisitos

        Used in referral for treatment and in claims processing.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Coverage.costToBeneficiary
        Definição

        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.

        CurtoPatient payments for services/products
        Comentários

        For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

        Controlo0..*
        TipoBackboneElement
        É modificadorfalse
        Resumofalse
        Requisitos

        Required by providers to manage financial transaction with the patient.

        Nomes alternativosCoPay, Deductible, Exceptions
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Coverage.costToBeneficiary.id
        Definição

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        CurtoUnique id for inter-element referencing
        Controlo0..1
        Tipostring
        É modificadorfalse
        Formato XMLNo formato XML, esta propriedade é representada como um atributo.
        Resumofalse
        64. Coverage.costToBeneficiary.extension
        Definição

        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.

        CurtoAdditional content defined by implementations
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadorfalse
        Resumofalse
        Nomes alternativosextensions, user content
        Invariantesele-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())
        66. Coverage.costToBeneficiary.modifierExtension
        Definição

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

        CurtoExtensions that cannot be ignored even if unrecognized
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Resumotrue
        Requisitos

        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.

        Nomes alternativosextensions, user content, modifiers
        Invariantesele-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())
        68. Coverage.costToBeneficiary.type
        Definição

        The category of patient centric costs associated with treatment.

        CurtoCost category
        Comentários

        For example visit, specialist visits, emergency, inpatient care, etc.

        Controlo0..1
        VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de CoverageCopayTypeCodes
        (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type|4.0.1)

        The types of services to which patient copayments are specified.

        TipoCodeableConcept
        É modificadorfalse
        Resumotrue
        Requisitos

        Needed to identify the category associated with the amount for the patient.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Coverage.costToBeneficiary.value[x]
        Definição

        The amount due from the patient for the cost category.

        CurtoThe amount or percentage due from the beneficiary
        Comentários

        Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

        Controlo1..1
        TipoEscolha de: Quantity(SimpleQuantity), Money
        [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
        É modificadorfalse
        Resumotrue
        Requisitos

        Needed to identify the amount for the patient associated with the category.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. Coverage.costToBeneficiary.exception
        Definição

        A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

        CurtoExceptions for patient payments
        Controlo0..*
        TipoBackboneElement
        É modificadorfalse
        Resumofalse
        Requisitos

        Required by providers to manage financial transaction with the patient.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Coverage.costToBeneficiary.exception.id
        Definição

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        CurtoUnique id for inter-element referencing
        Controlo0..1
        Tipostring
        É modificadorfalse
        Formato XMLNo formato XML, esta propriedade é representada como um atributo.
        Resumofalse
        76. Coverage.costToBeneficiary.exception.extension
        Definição

        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.

        CurtoAdditional content defined by implementations
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadorfalse
        Resumofalse
        Nomes alternativosextensions, user content
        Invariantesele-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.exception.modifierExtension
        Definição

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

        CurtoExtensions that cannot be ignored even if unrecognized
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Resumotrue
        Requisitos

        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.

        Nomes alternativosextensions, user content, modifiers
        Invariantesele-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.exception.type
        Definição

        The code for the specific exception.

        CurtoException category
        Controlo1..1
        VínculoPara exemplos de códigos, ver ExampleCoverageFinancialExceptionCodes
        (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception|4.0.1)

        The types of exceptions from the part or full value of financial obligations such as copays.

        TipoCodeableConcept
        É modificadorfalse
        Resumotrue
        Requisitos

        Needed to identify the exception associated with the amount for the patient.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. Coverage.costToBeneficiary.exception.period
        Definição

        The timeframe during when the exception is in force.

        CurtoThe effective period of the exception
        Controlo0..1
        TipoPeriod
        É modificadorfalse
        Resumotrue
        Requisitos

        Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Coverage.subrogation
        Definição

        When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

        CurtoReimbursement to insurer
        Comentários

        Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

        Controlo0..1
        Tipoboolean
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumofalse
        Requisitos

        See definition for when to be used.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. Coverage.contract
        Definição

        The policy(s) which constitute this insurance coverage.

        CurtoContract details
        Controlo0..*
        TipoReference(Contract)
        É modificadorfalse
        Resumofalse
        Requisitos

        To reference the legally binding contract between the policy holder and the insurer.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))