Guia de Implementação do Projeto de Padronização e Qualificação dos Dados Assistenciais da Saúde Suplementar (PQDAS)
202309 - CI Build Brazil flag

A caixa de publicação vai aqui

Resource Profile: NotificacaoPagamento - Descrições detalhadas

Active as of 2023-07-19

Definitions for the notificacao-pagamento resource profile.

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

0. PaymentNotice
Definition

Notificação de pagamento ao paciente ou prestador eventual

ShortNotificação de Pagamento
2. PaymentNotice.id
Definition

Identificador lógico da Notificação de Pagamento

ShortIdentificador lógico da Notificação de Pagamento
4. PaymentNotice.meta
Definition

Metadados da Notificação de Pagamento

ShortMetadados da Notificação de Pagamento
6. PaymentNotice.implicitRules
Definition

Regras de negócio da Notificação de Pagamento

ShortRegras de negócio da Notificação de Pagamento
8. PaymentNotice.language
Definition

Idioma da Notificação de Pagamento

ShortIdioma da Notificação de Pagamento
10. PaymentNotice.text
Definition

Elemento narrativo da Notificação de Pagamento

ShortElemento narrativo da Notificação de Pagamento
12. PaymentNotice.contained
Definition

Recursos contidos na Notificação de Pagamento

ShortRecursos contidos na Notificação de Pagamento
14. PaymentNotice.extension
ShortConjunto de campos adicionais que são extensões ao modelo de informação
Control1..?
SlicingThis element introduces a set of slices on PaymentNotice.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. PaymentNotice.extension:versaoPadrao
Slice NameversaoPadrao
Definition

Versão do padrão

ShortVersão do padrão
Control1..?
TypeExtension(Versão do componente de comunicação para o envio de dados para a ANS) (Extension Type: string)
18. PaymentNotice.modifierExtension
Definition

Extensões modificadores da Notificação de Pagamento

ShortExtensões modificadores da Notificação de Pagamento
20. PaymentNotice.identifier
Definition

Identificadores da Notificação de Pagamento

ShortIdentificadores da Notificação de Pagamento
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
SlicingThis element introduces a set of slices on PaymentNotice.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
22. PaymentNotice.identifier.use
Definition

Uso do identificador de pagamento

ShortUso do identificador de pagamento
24. PaymentNotice.identifier.type
Definition

Tipo do identificador de pagamento

ShortTipo do identificador de pagamento
26. PaymentNotice.identifier.system
Definition

Sistema do identificador de pagamento

ShortSistema do identificador de pagamento
28. PaymentNotice.identifier.value
Definition

Valor do identificador de pagamento

ShortValor do identificador de pagamento
30. PaymentNotice.identifier:numeroIdentificacaoReembolso
Slice NamenumeroIdentificacaoReembolso
Definition

Número de identificação do reembolso

ShortNúmero de identificação do reembolso
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
32. PaymentNotice.identifier:numeroIdentificacaoReembolso.id
Definition

Identificador lógico do número de identificação do reembolso

ShortIdentificador lógico do número de identificação do reembolso
34. PaymentNotice.identifier:numeroIdentificacaoReembolso.extension
Definition

Extensões do número de identificação do reembolso

ShortExtensões do número de identificação do reembolso
36. PaymentNotice.identifier:numeroIdentificacaoReembolso.use
Definition

Uso do número de identificação do reembolso

ShortUso do número de identificação do reembolso
38. PaymentNotice.identifier:numeroIdentificacaoReembolso.type
Definition

Tipo do número de identificação do reembolso

ShortTipo do número de identificação do reembolso
40. PaymentNotice.identifier:numeroIdentificacaoReembolso.system
Definition

Sistema do número de identificação do reembolso

ShortSistema do número de identificação do reembolso
Control1..?
Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-reembolso
42. PaymentNotice.identifier:numeroIdentificacaoReembolso.value
Definition

Valor do número de identificação do reembolso

ShortValor do número de identificação do reembolso
Control1..?
44. PaymentNotice.identifier:numeroIdentificacaoReembolso.period
Definition

Período de validade do número de identificação do reembolso

ShortPeríodo de validade do número de identificação do reembolso
46. PaymentNotice.identifier:numeroIdentificacaoReembolso.assigner
Definition

Entidade responsável pela atribuição do número de identificação do reembolso

ShortEntidade responsável pela atribuição do número de identificação do reembolso
48. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido
Slice NamenumeroIdentificacaoPreEstabelecido
Definition

Número de identificação do pré-estabelecido

ShortNúmero de identificação do pré-estabelecido
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
50. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.id
Definition

Identificador lógico do número de identificação do pré-estabelecido

ShortIdentificador lógico do número de identificação do pré-estabelecido
52. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.extension
Definition

Extensões do número de identificação do pré-estabelecido

ShortExtensões do número de identificação do pré-estabelecido
54. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.use
Definition

Uso do número de identificação do pré-estabelecido

ShortUso do número de identificação do pré-estabelecido
56. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.type
Definition

Tipo do número de identificação do pré-estabelecido

ShortTipo do número de identificação do pré-estabelecido
58. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.system
Definition

Sistema do número de identificação do pré-estabelecido

ShortSistema do número de identificação do pré-estabelecido
Control1..?
Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-preestabelecido
60. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.value
Definition

Valor do número de identificação do pré-estabelecido

ShortValor do número de identificação do pré-estabelecido
Control1..?
62. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.period
Definition

Período de validade do número de identificação do pré-estabelecido

ShortPeríodo de validade do número de identificação do pré-estabelecido
64. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.assigner
Definition

Entidade responsável pela atribuição do número de identificação do pré-estabelecido

ShortEntidade responsável pela atribuição do número de identificação do pré-estabelecido
66. PaymentNotice.status
Definition

Status da Notificação de Pagamento

ShortStatus da Notificação de Pagamento
68. PaymentNotice.request
Definition

Requisição da Notificação de Pagamento

ShortRequisição da Notificação de Pagamento
70. PaymentNotice.response
Definition

Resposta da Notificação de Pagamento

ShortResposta da Notificação de Pagamento
72. PaymentNotice.created
Definition

Data de criação da Notificação de Pagamento

ShortData de criação da Notificação de Pagamento
74. PaymentNotice.provider
Definition

Prestador da Notificação de Pagamento

ShortPrestador da Notificação de Pagamento
Control1..?
TypeReference(Estabelecimento de Saúde, Operadora de plano privado de assistência à saúde, Profissional prestador do serviço)
76. PaymentNotice.payment
Definition

Pagamento da Notificação de Pagamento

ShortPagamento da Notificação de Pagamento
TypeReference(Reconciliação de Pagamento (e modelos de remuneração))
78. PaymentNotice.paymentDate
Definition

Data da Notificação de Pagamento

ShortData da Notificação de Pagamento
80. PaymentNotice.payee
Definition

Beneficiário da Notificação de Pagamento

ShortBeneficiário da Notificação de Pagamento
TypeReference(Estabelecimento de Saúde, Profissional prestador do serviço)
82. PaymentNotice.recipient
Definition

Destinatário da Notificação de Pagamento

ShortDestinatário da Notificação de Pagamento
TypeReference(Operadora de plano privado de assistência à saúde)
84. PaymentNotice.amount
Definition

Valor da Notificação de Pagamento

ShortValor da Notificação de Pagamento
86. PaymentNotice.paymentStatus
Definition

Status do Pagamento da Notificação de Pagamento

ShortStatus do Pagamento da Notificação de Pagamento
BindingThe codes SHALL be taken from tipo de faturamento

Status do Pagamento da Notificação de Pagamento

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

0. PaymentNotice
Definition

Notificação de pagamento ao paciente ou prestador eventual


This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

ShortNotificação de PagamentoPaymentNotice request
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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. PaymentNotice.id
Definition

Identificador lógico da Notificação de Pagamento


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

ShortIdentificador lógico da Notificação de PagamentoLogical 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.

Control0..1
Typeidstring
Is Modifierfalse
Summarytrue
4. PaymentNotice.meta
Definition

Metadados da Notificação de Pagamento


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.

ShortMetadados da Notificação de PagamentoMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. PaymentNotice.implicitRules
Definition

Regras de negócio da Notificação de Pagamento


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.

ShortRegras de negócio da Notificação de PagamentoA 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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PaymentNotice.language
Definition

Idioma da Notificação de Pagamento


The base language in which the resource is written.

ShortIdioma da Notificação de PagamentoLanguage 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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PaymentNotice.text
Definition

Elemento narrativo da Notificação de Pagamento


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.

ShortElemento narrativo da Notificação de PagamentoText 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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. PaymentNotice.contained
Definition

Recursos contidos na Notificação de Pagamento


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.

ShortRecursos contidos na Notificação de PagamentoContained, 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. PaymentNotice.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.

ShortConjunto de campos adicionais que são extensões ao modelo de informaçãoAdditional 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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. PaymentNotice.extension:versaoPadrao
Slice NameversaoPadrao
Definition

Versão do padrão

ShortVersão do padrão
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Versão do componente de comunicação para o envio de dados para a ANS) (Extension Type: string)
Is Modifierfalse
Invariantsele-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())
18. PaymentNotice.modifierExtension
Definition

Extensões modificadores da Notificação de Pagamento


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

ShortExtensões modificadores da Notificação de PagamentoExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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. PaymentNotice.identifier
Definition

Identificadores da Notificação de Pagamento


A unique identifier assigned to this payment notice.

ShortIdentificadores da Notificação de PagamentoBusiness Identifier for the payment noctice
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PaymentNotice.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
22. PaymentNotice.identifier.use
Definition

Uso do identificador de pagamento


The purpose of this identifier.

ShortUso do identificador de pagamentousual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. PaymentNotice.identifier.type
Definition

Tipo do identificador de pagamento


A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortTipo do identificador de pagamentoDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. PaymentNotice.identifier.system
Definition

Sistema do identificador de pagamento


Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortSistema do identificador de pagamentoThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PaymentNotice.identifier.value
Definition

Valor do identificador de pagamento


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortValor do identificador de pagamentoThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PaymentNotice.identifier:numeroIdentificacaoReembolso
Slice NamenumeroIdentificacaoReembolso
Definition

Número de identificação do reembolso


A unique identifier assigned to this payment notice.

ShortNúmero de identificação do reembolsoBusiness Identifier for the payment noctice
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. PaymentNotice.identifier:numeroIdentificacaoReembolso.id
Definition

Identificador lógico do número de identificação do reembolso


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

ShortIdentificador lógico do número de identificação do reembolsoUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
34. PaymentNotice.identifier:numeroIdentificacaoReembolso.extension
Definition

Extensões do número de identificação do reembolso


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.

ShortExtensões do número de identificação do reembolsoAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. PaymentNotice.identifier:numeroIdentificacaoReembolso.use
Definition

Uso do número de identificação do reembolso


The purpose of this identifier.

ShortUso do número de identificação do reembolsousual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PaymentNotice.identifier:numeroIdentificacaoReembolso.type
Definition

Tipo do número de identificação do reembolso


A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortTipo do número de identificação do reembolsoDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PaymentNotice.identifier:numeroIdentificacaoReembolso.system
Definition

Sistema do número de identificação do reembolso


Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortSistema do número de identificação do reembolsoThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-reembolso
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PaymentNotice.identifier:numeroIdentificacaoReembolso.value
Definition

Valor do número de identificação do reembolso


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortValor do número de identificação do reembolsoThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PaymentNotice.identifier:numeroIdentificacaoReembolso.period
Definition

Período de validade do número de identificação do reembolso


Time period during which identifier is/was valid for use.

ShortPeríodo de validade do número de identificação do reembolsoTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PaymentNotice.identifier:numeroIdentificacaoReembolso.assigner
Definition

Entidade responsável pela atribuição do número de identificação do reembolso


Organization that issued/manages the identifier.

ShortEntidade responsável pela atribuição do número de identificação do reembolsoOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido
Slice NamenumeroIdentificacaoPreEstabelecido
Definition

Número de identificação do pré-estabelecido


A unique identifier assigned to this payment notice.

ShortNúmero de identificação do pré-estabelecidoBusiness Identifier for the payment noctice
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.id
Definition

Identificador lógico do número de identificação do pré-estabelecido


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

ShortIdentificador lógico do número de identificação do pré-estabelecidoUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
52. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.extension
Definition

Extensões do número de identificação do pré-estabelecido


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.

ShortExtensões do número de identificação do pré-estabelecidoAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.use
Definition

Uso do número de identificação do pré-estabelecido


The purpose of this identifier.

ShortUso do número de identificação do pré-estabelecidousual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.type
Definition

Tipo do número de identificação do pré-estabelecido


A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortTipo do número de identificação do pré-estabelecidoDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.system
Definition

Sistema do número de identificação do pré-estabelecido


Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortSistema do número de identificação do pré-estabelecidoThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-preestabelecido
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.value
Definition

Valor do número de identificação do pré-estabelecido


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortValor do número de identificação do pré-estabelecidoThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.period
Definition

Período de validade do número de identificação do pré-estabelecido


Time period during which identifier is/was valid for use.

ShortPeríodo de validade do número de identificação do pré-estabelecidoTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.assigner
Definition

Entidade responsável pela atribuição do número de identificação do pré-estabelecido


Organization that issued/manages the identifier.

ShortEntidade responsável pela atribuição do número de identificação do pré-estabelecidoOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PaymentNotice.status
Definition

Status da Notificação de Pagamento


The status of the resource instance.

ShortStatus da Notificação de Pagamentoactive | cancelled | draft | entered-in-error
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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'.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PaymentNotice.request
Definition

Requisição da Notificação de Pagamento


Reference of resource for which payment is being made.

ShortRequisição da Notificação de PagamentoRequest reference
Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PaymentNotice.response
Definition

Resposta da Notificação de Pagamento


Reference of response to resource for which payment is being made.

ShortResposta da Notificação de PagamentoResponse reference
Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PaymentNotice.created
Definition

Data de criação da Notificação de Pagamento


The date when this resource was created.

ShortData de criação da Notificação de PagamentoCreation date
Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PaymentNotice.provider
Definition

Prestador da Notificação de Pagamento


The practitioner who is responsible for the services rendered to the patient.

ShortPrestador da Notificação de PagamentoResponsible practitioner
Control10..1
TypeReference(Estabelecimento de Saúde, Operadora de plano privado de assistência à saúde, Profissional prestador do serviço, Practitioner, PractitionerRole, Organization)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PaymentNotice.payment
Definition

Pagamento da Notificação de Pagamento


A reference to the payment which is the subject of this notice.

ShortPagamento da Notificação de PagamentoPayment reference
Control1..1
TypeReference(Reconciliação de Pagamento (e modelos de remuneração), PaymentReconciliation)
Is Modifierfalse
Summarytrue
Requirements

Need to identify the actual payment.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PaymentNotice.paymentDate
Definition

Data da Notificação de Pagamento


The date when the above payment action occurred.

ShortData da Notificação de PagamentoPayment or clearing date
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Need to convey the date when the action being notified occurred.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PaymentNotice.payee
Definition

Beneficiário da Notificação de Pagamento


The party who will receive or has received payment that is the subject of this notification.

ShortBeneficiário da Notificação de PagamentoParty being paid
Control0..1
TypeReference(Estabelecimento de Saúde, Profissional prestador do serviço, Practitioner, PractitionerRole, Organization)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PaymentNotice.recipient
Definition

Destinatário da Notificação de Pagamento


The party who is notified of the payment status.

ShortDestinatário da Notificação de PagamentoParty being notified
Control1..1
TypeReference(Operadora de plano privado de assistência à saúde, Organization)
Is Modifierfalse
Summarytrue
Requirements

Need to identified the recipient of the notification.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PaymentNotice.amount
Definition

Valor da Notificação de Pagamento


The amount sent to the payee.

ShortValor da Notificação de PagamentoMonetary amount of the payment
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Provided for validation purposes.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. PaymentNotice.paymentStatus
Definition

Status do Pagamento da Notificação de Pagamento


A code indicating whether payment has been sent or cleared.

ShortStatus do Pagamento da Notificação de PagamentoIssued or cleared Status of the payment
Comments

Typically paid: payment sent, cleared: payment received.

Control0..1
BindingThe codes SHALL be taken from For example codes, see tipo de faturamentohttp://hl7.org/fhir/ValueSet/payment-status

Status do Pagamento da Notificação de Pagamento


The payment conveyance status codes.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

The purpose of the notification.

Invariantsele-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 found here

0. PaymentNotice
Definition

Notificação de pagamento ao paciente ou prestador eventual

ShortNotificação de Pagamento
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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. PaymentNotice.id
Definition

Identificador lógico da Notificação de Pagamento

ShortIdentificador lógico da Notificação de Pagamento
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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. PaymentNotice.meta
Definition

Metadados da Notificação de Pagamento

ShortMetadados da Notificação de Pagamento
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. PaymentNotice.implicitRules
Definition

Regras de negócio da Notificação de Pagamento

ShortRegras de negócio da Notificação de Pagamento
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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PaymentNotice.language
Definition

Idioma da Notificação de Pagamento

ShortIdioma da Notificação de Pagamento
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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PaymentNotice.text
Definition

Elemento narrativo da Notificação de Pagamento

ShortElemento narrativo da Notificação de Pagamento
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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. PaymentNotice.contained
Definition

Recursos contidos na Notificação de Pagamento

ShortRecursos contidos na Notificação de Pagamento
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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. PaymentNotice.extension
Definition

An Extension

ShortConjunto de campos adicionais que são extensões ao modelo de informação
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. PaymentNotice.extension:versaoPadrao
Slice NameversaoPadrao
Definition

Versão do padrão

ShortVersão do padrão
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Versão do componente de comunicação para o envio de dados para a ANS) (Extension Type: string)
Is Modifierfalse
Invariantsele-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. PaymentNotice.modifierExtension
Definition

Extensões modificadores da Notificação de Pagamento

ShortExtensões modificadores da Notificação de Pagamento
Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Invariantsele-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. PaymentNotice.identifier
Definition

Identificadores da Notificação de Pagamento

ShortIdentificadores da Notificação de Pagamento
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PaymentNotice.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
22. PaymentNotice.identifier.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
24. PaymentNotice.identifier.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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. PaymentNotice.identifier.use
Definition

Uso do identificador de pagamento

ShortUso do identificador de pagamento
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PaymentNotice.identifier.type
Definition

Tipo do identificador de pagamento

ShortTipo do identificador de pagamento
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PaymentNotice.identifier.system
Definition

Sistema do identificador de pagamento

ShortSistema do identificador de pagamento
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. PaymentNotice.identifier.value
Definition

Valor do identificador de pagamento

ShortValor do identificador de pagamento
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. PaymentNotice.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. PaymentNotice.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PaymentNotice.identifier:numeroIdentificacaoReembolso
Slice NamenumeroIdentificacaoReembolso
Definition

Número de identificação do reembolso

ShortNúmero de identificação do reembolso
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PaymentNotice.identifier:numeroIdentificacaoReembolso.id
Definition

Identificador lógico do número de identificação do reembolso

ShortIdentificador lógico do número de identificação do reembolso
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
42. PaymentNotice.identifier:numeroIdentificacaoReembolso.extension
Definition

Extensões do número de identificação do reembolso

ShortExtensões do número de identificação do reembolso
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. PaymentNotice.identifier:numeroIdentificacaoReembolso.use
Definition

Uso do número de identificação do reembolso

ShortUso do número de identificação do reembolso
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PaymentNotice.identifier:numeroIdentificacaoReembolso.type
Definition

Tipo do número de identificação do reembolso

ShortTipo do número de identificação do reembolso
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PaymentNotice.identifier:numeroIdentificacaoReembolso.system
Definition

Sistema do número de identificação do reembolso

ShortSistema do número de identificação do reembolso
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-reembolso
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PaymentNotice.identifier:numeroIdentificacaoReembolso.value
Definition

Valor do número de identificação do reembolso

ShortValor do número de identificação do reembolso
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PaymentNotice.identifier:numeroIdentificacaoReembolso.period
Definition

Período de validade do número de identificação do reembolso

ShortPeríodo de validade do número de identificação do reembolso
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PaymentNotice.identifier:numeroIdentificacaoReembolso.assigner
Definition

Entidade responsável pela atribuição do número de identificação do reembolso

ShortEntidade responsável pela atribuição do número de identificação do reembolso
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido
Slice NamenumeroIdentificacaoPreEstabelecido
Definition

Número de identificação do pré-estabelecido

ShortNúmero de identificação do pré-estabelecido
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Summaryfalse
Requirements

Allows payment notices to be distinguished and referenced.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.id
Definition

Identificador lógico do número de identificação do pré-estabelecido

ShortIdentificador lógico do número de identificação do pré-estabelecido
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
60. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.extension
Definition

Extensões do número de identificação do pré-estabelecido

ShortExtensões do número de identificação do pré-estabelecido
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on PaymentNotice.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.use
Definition

Uso do número de identificação do pré-estabelecido

ShortUso do número de identificação do pré-estabelecido
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.type
Definition

Tipo do número de identificação do pré-estabelecido

ShortTipo do número de identificação do pré-estabelecido
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.system
Definition

Sistema do número de identificação do pré-estabelecido

ShortSistema do número de identificação do pré-estabelecido
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.ans.gov.br/sid/numero-identificacao-preestabelecido
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.value
Definition

Valor do número de identificação do pré-estabelecido

ShortValor do número de identificação do pré-estabelecido
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.period
Definition

Período de validade do número de identificação do pré-estabelecido

ShortPeríodo de validade do número de identificação do pré-estabelecido
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PaymentNotice.identifier:numeroIdentificacaoPreEstabelecido.assigner
Definition

Entidade responsável pela atribuição do número de identificação do pré-estabelecido

ShortEntidade responsável pela atribuição do número de identificação do pré-estabelecido
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PaymentNotice.status
Definition

Status da Notificação de Pagamento

ShortStatus da Notificação de Pagamento
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodes

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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'.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PaymentNotice.request
Definition

Requisição da Notificação de Pagamento

ShortRequisição da Notificação de Pagamento
Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PaymentNotice.response
Definition

Resposta da Notificação de Pagamento

ShortResposta da Notificação de Pagamento
Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PaymentNotice.created
Definition

Data de criação da Notificação de Pagamento

ShortData de criação da Notificação de Pagamento
Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PaymentNotice.provider
Definition

Prestador da Notificação de Pagamento

ShortPrestador da Notificação de Pagamento
Control1..1
TypeReference(Estabelecimento de Saúde, Operadora de plano privado de assistência à saúde, Profissional prestador do serviço)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PaymentNotice.payment
Definition

Pagamento da Notificação de Pagamento

ShortPagamento da Notificação de Pagamento
Control1..1
TypeReference(Reconciliação de Pagamento (e modelos de remuneração))
Is Modifierfalse
Summarytrue
Requirements

Need to identify the actual payment.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. PaymentNotice.paymentDate
Definition

Data da Notificação de Pagamento

ShortData da Notificação de Pagamento
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Need to convey the date when the action being notified occurred.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. PaymentNotice.payee
Definition

Beneficiário da Notificação de Pagamento

ShortBeneficiário da Notificação de Pagamento
Control0..1
TypeReference(Estabelecimento de Saúde, Profissional prestador do serviço)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PaymentNotice.recipient
Definition

Destinatário da Notificação de Pagamento

ShortDestinatário da Notificação de Pagamento
Control1..1
TypeReference(Operadora de plano privado de assistência à saúde)
Is Modifierfalse
Summarytrue
Requirements

Need to identified the recipient of the notification.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. PaymentNotice.amount
Definition

Valor da Notificação de Pagamento

ShortValor da Notificação de Pagamento
Control1..1
TypeMoney
Is Modifierfalse
Summarytrue
Requirements

Provided for validation purposes.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PaymentNotice.paymentStatus
Definition

Status do Pagamento da Notificação de Pagamento

ShortStatus do Pagamento da Notificação de Pagamento
Comments

Typically paid: payment sent, cleared: payment received.

Control0..1
BindingThe codes SHALL be taken from tipo de faturamento

Status do Pagamento da Notificação de Pagamento

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

The purpose of the notification.

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