REDS GO
1.0.0 - draft Brazil flag

REDS GO - Downloaded Version 1.0.0 See the Directory of published versions

Resource Profile: BRPessoaJuridicaProfissionalLiberal - Detailed Descriptions

Active as of 2020-03-11

Definitions for the BRPessoaJuridicaProfissionalLiberal-1.0 resource profile.

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

0. Organization
Definição

Pessoa jurídica identificada no âmbito da Receita Federal do Brasil pelo Cadastro Nacional da Pessoa Jurídica (CNPJ) ou profissional liberal identificado pelo Cadastro de Pessoas Físicas (CPF).


A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

CurtoPessoa Jurídica e Profissional LiberalA grouping of people or organizations with a common purpose
Controlo0..*
É modificadorfalse
Deve apoiartrue
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())
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
2. Organization.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()))
4. Organization.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())
6. Organization.identifier
Definição

Identifier for the organization that is used to identify the organization across multiple disparate systems.

CurtoIdentifies this organization across multiple systems
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0*
Este elemento é afetado pelas seguintes invariantes: org-1
TipoIdentifier
É modificadorfalse
Resumotrue
Requisitos

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

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

Se a Pessoa Jurídia ainda está ativa.


Whether the organization's record is still in active use.

CurtoPessoa Jurídica AtivaWhether the organization's record is still in active use
Comentários

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Controlo10..1
Tipoboolean
É modificadortrue porque This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiartrue
Resumotrue
Requisitos

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Significado em caso de faltaThis resource is generally assumed to be active if no value is provided for the active element
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Organization.type
Definição

Identifica a constituição jurídico-institucional das entidades públicas e privadas nos cadastros da administração pública do Brasil.


The kind(s) of organization that this is.

CurtoNatureza JurídicaKind of organization
Comentários

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Controlo10..1*
VínculoOs códigos DEVERÃO ser retirados de Para exemplos de códigos, ver Natureza Jurídicahttp://hl7.org/fhir/ValueSet/organization-type
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRNaturezaJuridica-1.0)

Natureza Jurídica


Used to categorize the organization.

TipoCodeableConcept
É modificadorfalse
Deve apoiartrue
Resumotrue
Requisitos

Need to be able to track the kind of organization that this is - different organization types have different uses.

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

A reference to a code defined by a terminology system.

CurtoCode defined by a terminology system
Comentários

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Controlo10..1*
TipoCoding
É modificadorfalse
Resumotrue
Requisitos

Allows for alternative encodings within a code system, and translations to other code systems.

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

The identification of the code system that defines the meaning of the symbol in the code.

CurtoIdentity of the terminology system
Comentários

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

Need to be unambiguous about the source of the definition of the symbol.

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

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

CurtoSymbol in syntax defined by the system
Controlo10..1
Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Requisitos

Need to refer to a particular code in the system.

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

A representation of the meaning of the code in the system, following the rules of the system.

CurtoRepresentation defined by the system
Controlo0..01
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Requisitos

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

CurtoIf this coding was chosen directly by the user
Comentários

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

CurtoPlain text representation of the concept
Comentários

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

Nome empresarial da Pessoa Jurídica.


A name associated with the organization.

CurtoNomeName used for the organization
Comentários

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Controlo10..1
Este elemento é afetado pelas seguintes invariantes: org-1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiartrue
Resumotrue
Requisitos

Need to use the name as the label of the organization.

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

Nome fantasia da Pessoa Jurídica.


A list of alternate names that the organization is known as, or was known as in the past.

CurtoNome FantasiaA list of alternate names that the organization is known as, or was known as in the past
Comentários

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

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

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

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

A contact detail for the organization.

CurtoA contact detail for the organization
Comentários

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Controlo0..0*
Este elemento é afetado pelas seguintes invariantes: org-3
TipoContactPoint
É modificadorfalse
Resumofalse
Requisitos

Human contact for the organization.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
30. Organization.address
Definição

An address for the organization.

CurtoAn address for the organization
Comentários

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Controlo0..0*
Este elemento é afetado pelas seguintes invariantes: org-2
TipoAddress
É modificadorfalse
Resumofalse
Requisitos

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
32. Organization.partOf
Definição

The organization of which this organization forms a part.

CurtoThe organization of which this organization forms a part
Controlo0..01
TipoReference(Organization)
É modificadorfalse
Resumotrue
Requisitos

Need to be able to track the hierarchy of organizations within an organization.

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

Contact for the organization for a certain purpose.

CurtoContact for the organization for a certain purpose
Comentários

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Controlo0..0*
TipoBackboneElement
É modificadorfalse
Resumofalse
Requisitos

Need to keep track of assigned contact points within bigger organization.

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

Technical endpoints providing access to services operated for the organization.

CurtoTechnical endpoints providing access to services operated for the organization
Controlo0..0*
TipoReference(Endpoint)
É modificadorfalse
Resumofalse
Requisitos

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

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. Organization
Definição

Pessoa jurídica identificada no âmbito da Receita Federal do Brasil pelo Cadastro Nacional da Pessoa Jurídica (CNPJ) ou profissional liberal identificado pelo Cadastro de Pessoas Físicas (CPF).

CurtoPessoa Jurídica e Profissional Liberal
Deve apoiartrue
2. Organization.identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
4. Organization.active
Definição

Se a Pessoa Jurídia ainda está ativa.

CurtoPessoa Jurídica Ativa
Controlo1..?
Deve apoiartrue
6. Organization.type
Definição

Identifica a constituição jurídico-institucional das entidades públicas e privadas nos cadastros da administração pública do Brasil.

CurtoNatureza Jurídica
Controlo1..1
VínculoOs códigos DEVERÃO ser retirados de Natureza Jurídica
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRNaturezaJuridica-1.0)

Natureza Jurídica

Deve apoiartrue
8. Organization.type.coding
Controlo1..1
10. Organization.type.coding.system
Controlo1..?
12. Organization.type.coding.code
Controlo1..?
14. Organization.type.coding.display
Controlo0..0
16. Organization.type.coding.userSelected
Controlo0..0
18. Organization.type.text
Controlo0..0
20. Organization.name
Definição

Nome empresarial da Pessoa Jurídica.

CurtoNome
Controlo1..?
Deve apoiartrue
22. Organization.alias
Definição

Nome fantasia da Pessoa Jurídica.

CurtoNome Fantasia
Controlo0..1
Deve apoiartrue
24. Organization.telecom
Controlo0..0
26. Organization.address
Controlo0..0
28. Organization.partOf
Controlo0..0
30. Organization.contact
Controlo0..0
32. Organization.endpoint
Controlo0..0

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

0. Organization
Definição

Pessoa jurídica identificada no âmbito da Receita Federal do Brasil pelo Cadastro Nacional da Pessoa Jurídica (CNPJ) ou profissional liberal identificado pelo Cadastro de Pessoas Físicas (CPF).

CurtoPessoa Jurídica e Profissional Liberal
Controlo0..*
É modificadorfalse
Deve apoiartrue
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())
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
2. Organization.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.

Controlo0..1
Tipoid
É modificadorfalse
Resumotrue
4. Organization.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. Organization.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. Organization.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)

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. Organization.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. Organization.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. Organization.extension
Definição

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.

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())
16. Organization.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())
18. Organization.identifier
Definição

Identifier for the organization that is used to identify the organization across multiple disparate systems.

CurtoIdentifies this organization across multiple systems
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
Este elemento é afetado pelas seguintes invariantes: org-1
TipoIdentifier
É modificadorfalse
Resumotrue
Requisitos

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

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

Se a Pessoa Jurídia ainda está ativa.

CurtoPessoa Jurídica Ativa
Comentários

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Controlo1..1
Tipoboolean
É modificadortrue porque This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiartrue
Resumotrue
Requisitos

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Significado em caso de faltaThis resource is generally assumed to be active if no value is provided for the active element
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Organization.type
Definição

Identifica a constituição jurídico-institucional das entidades públicas e privadas nos cadastros da administração pública do Brasil.

CurtoNatureza Jurídica
Comentários

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Controlo1..1
VínculoOs códigos DEVERÃO ser retirados de Natureza Jurídica
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRNaturezaJuridica-1.0)

Natureza Jurídica

TipoCodeableConcept
É modificadorfalse
Deve apoiartrue
Resumotrue
Requisitos

Need to be able to track the kind of organization that this is - different organization types have different uses.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Organization.type.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
26. Organization.type.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())
SlicingEste elemento introduz um conjunto de fatias em Organization.type.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 28. Organization.type.coding
    Definição

    A reference to a code defined by a terminology system.

    CurtoCode defined by a terminology system
    Comentários

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Controlo1..1
    TipoCoding
    É modificadorfalse
    Resumotrue
    Requisitos

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Organization.type.coding.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
    32. Organization.type.coding.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())
    SlicingEste elemento introduz um conjunto de fatias em Organization.type.coding.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 34. Organization.type.coding.system
      Definição

      The identification of the code system that defines the meaning of the symbol in the code.

      CurtoIdentity of the terminology system
      Comentários

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

      Need to be unambiguous about the source of the definition of the symbol.

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

      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

      CurtoVersion of the system - if relevant
      Comentários

      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

      NotaEste é um ID de versão comercial, não um ID de versão de recurso (ver discussão)
      Controlo0..1
      Tipostring
      É modificadorfalse
      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()))
      38. Organization.type.coding.code
      Definição

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      CurtoSymbol in syntax defined by the system
      Controlo1..1
      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Requisitos

      Need to refer to a particular code in the system.

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

      A representation of the meaning of the code in the system, following the rules of the system.

      CurtoRepresentation defined by the system
      Controlo0..0
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Requisitos

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

      CurtoIf this coding was chosen directly by the user
      Comentários

      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      CurtoPlain text representation of the concept
      Comentários

      Very often the text is the same as a displayName of one of the codings.

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

      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

      Nome empresarial da Pessoa Jurídica.

      CurtoNome
      Comentários

      If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

      Controlo1..1
      Este elemento é afetado pelas seguintes invariantes: org-1
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

      Need to use the name as the label of the organization.

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

      Nome fantasia da Pessoa Jurídica.

      CurtoNome Fantasia
      Comentários

      There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

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

      Over time locations and organizations go through many changes and can be known by different names.

      For searching knowing previous names that the organization was known by can be very useful.

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

      A contact detail for the organization.

      CurtoA contact detail for the organization
      Comentários

      The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

      Controlo0..0
      Este elemento é afetado pelas seguintes invariantes: org-3
      TipoContactPoint
      É modificadorfalse
      Resumofalse
      Requisitos

      Human contact for the organization.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      52. Organization.address
      Definição

      An address for the organization.

      CurtoAn address for the organization
      Comentários

      Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

      Controlo0..0
      Este elemento é afetado pelas seguintes invariantes: org-2
      TipoAddress
      É modificadorfalse
      Resumofalse
      Requisitos

      May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
      54. Organization.partOf
      Definição

      The organization of which this organization forms a part.

      CurtoThe organization of which this organization forms a part
      Controlo0..0
      TipoReference(Organization)
      É modificadorfalse
      Resumotrue
      Requisitos

      Need to be able to track the hierarchy of organizations within an organization.

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

      Contact for the organization for a certain purpose.

      CurtoContact for the organization for a certain purpose
      Comentários

      Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

      Controlo0..0
      TipoBackboneElement
      É modificadorfalse
      Resumofalse
      Requisitos

      Need to keep track of assigned contact points within bigger organization.

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

      Technical endpoints providing access to services operated for the organization.

      CurtoTechnical endpoints providing access to services operated for the organization
      Controlo0..0
      TipoReference(Endpoint)
      É modificadorfalse
      Resumofalse
      Requisitos

      Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

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