Guia de Implementação da SES GO - CORE
0.0.1 - draft Brazil flag

Guia de Implementação da SES GO - CORE - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Individuo - Detailed Descriptions

Active as of 2025-01-17

Definitions for the individuo resource profile.

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

0. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

ShortDados demográficos do indivíduoInformation about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident
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())
NoMaximoUmaMaeBiologica: Deve existir no máximo uma mãe biológica. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0101').count() <= 1)
NoMaximoUmPaiBiologico: Deve existir no máximo um pai biológico. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0201').count() <= 1)
BrasileiroSeSomenteSeNasceNoBrasil: Brasileiro SE SOMENTE SE nasce no Brasil. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country = '10').exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country != '10').exists())
CidadeNascimento: Brasileiro informa a cidade de nascimento. Não brasileiro não informa a cidade de nascimento. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists().not())
ContatoEmergenciaUnico: Contato de emergência não deve ter duplicidades (contact.select(telecom).select(value).isDistinct())
2. Patient.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA 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()))
4. Patient.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.

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

Control40..*
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 Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Patient.extension:raca
    Slice Nameraca
    Definition

    Dados relacionados à raça/cor e etnia de um indivíduo.

    ShortRaça/Cor e Etnia
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Raça/Cor e Etnina) (Complex Extension)
    Is Modifierfalse
    Alternate Namesraça, etnia, cor, cútis
    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())
    8. Patient.extension:orientacaoSexual
    Slice NameorientacaoSexual
    Definition

    Extensão para informar a orientação sexual

    ShortOrientação Sexual
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Orientação Sexual) (Extension Type: code)
    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())
    10. Patient.extension:filiacao
    Slice Namefiliacao
    Definition

    Filiação

    ShortFiliação
    Control1..4
    This element is affected by the following invariants: ele-1
    TypeExtension(Filiação) (Complex Extension)
    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())
    NomeCompletoDeveConterNoMinimoDoisNomes: Nome deve ser composto por no mínimo nome e sobrenome (extension.where(url = 'nome').value.split(' ').count() > 1)
    12. Patient.extension:povosComunidadesTradicionais
    Slice NamepovosComunidadesTradicionais
    Definition

    Extensão para informar o pertencimento a povos e comunidades tradicionais

    ShortPovos e comunidades tradicionais
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Povos e comunidades tradicionais) (Extension Type: code)
    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())
    14. Patient.extension:nacionalidade
    Slice Namenacionalidade
    Definition

    An Extension

    ShortNacionalidade
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Nacionalidade) (Extension Type: CodeableConcept)
    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())
    16. Patient.extension:localNascimento
    Slice NamelocalNascimento
    Definition

    The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

    ShortPlace of Birth for patient
    Control1..1
    TypeExtension(Patient Birth Place) (Extension Type: Address)
    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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Patient.extension:localNascimento.extension
    Definition

    An Extension


    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.

    ShortExtensionAdditional 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..0*
    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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. Patient.extension:localNascimento.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace
      22. Patient.extension:localNascimento.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      This element is affected by the following invariants: ext-1
      TypeAddress(Local Nascimento), date, Meta, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Patient.extension:identidadeGenero
      Slice NameidentidadeGenero
      Definition

      The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient.

      ShortThe patient's gender identity
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
      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())
      26. Patient.extension:identidadeGenero.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional 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..0*
      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 Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 28. Patient.extension:identidadeGenero.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-genderIdentity
        30. Patient.extension:identidadeGenero.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control10..1
        BindingThe codes SHALL be taken from For codes, see Identidade de gênero
        (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/identidade-genero)
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Patient.extension:biometria
        Slice Namebiometria
        Definition

        Biometria

        ShortBiometria
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Biometria) (Complex Extension)
        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())
        34. Patient.extension:ocupacao
        Slice Nameocupacao
        Definition

        Ocupação refere-se à atividade profissional desempenhada por um indivíduo em um determinado campo de trabalho, conforme definido e categorizado pela Classificação Brasileira de Ocupações (CBO). Cada ocupação é identificada por um código específico no CBO, que descreve as principais responsabilidades, habilidades necessárias e condições de trabalho associadas àquela ocupação.

        ShortOcupacao
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Ocupacao) (Extension Type: Reference(Ocupacao))
        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())
        36. Patient.extension:escolaridade
        Slice Nameescolaridade
        Definition

        Escolaridade se refere ao nível de educação formal alcançado por um indivíduo, geralmente medido em termos de anos de estudo completados ou de diplomas obtidos. Essa medida é frequentemente usada para avaliar o conhecimento e as habilidades de uma pessoa em um determinado contexto educacional ou profissional.

        ShortEscolaridade
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Escolaridade) (Extension Type: Reference(Escolaridade))
        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())
        38. Patient.extension:situacaoMercadoTrabalho
        Slice NamesituacaoMercadoTrabalho
        Definition

        Situação no mercado de trabalho se refere ao estado ou condição de emprego de uma pessoa em relação ao ambiente econômico mais amplo..

        ShortOcupacao
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Ocupacao) (Extension Type: Reference(SituacaoMercadoTrabalho))
        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())
        40. Patient.modifierExtension
        Definition

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

        ShortExtensions 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())
        42. Patient.identifier
        Definition

        An identifier for this patient.

        ShortNúmero de documento que identifica o cidadãoAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control20..2*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

        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 Patient.identifier. The slices areOrdered and Closed, and can be differentiated using the following discriminators:
        • pattern @ system
        • 44. Patient.identifier:cpf
          Slice Namecpf
          Definition

          An identifier for this patient.

          ShortIdentificação pelo Cadastro de Pessoas FísicasAn identifier for this patient
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control10..1*
          TypeIdentifier
          Is Modifierfalse
          Summarytrue
          Requirements

          Patients are almost always assigned specific numerical identifiers.

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

          An Extension


          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.

          ShortExtensionAdditional 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..0*
          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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 48. Patient.identifier:cpf.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

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

            Control0..01
            BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
            (required to http://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()))
            50. Patient.identifier:cpf.type
            Definition

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

            ShortDescription 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..01
            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
            (extensible to http://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()))
            52. Patient.identifier:cpf.system
            Definition

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

            ShortO identificador do sistema de identificaçãoThe 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.

            Pattern Valuehttps://fhir.saude.go.gov.br/sid/cpf
            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()))
            54. Patient.identifier:cpf.value
            Definition

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

            ShortNúmero do Cadastro de Pessoas Físicas do indivíduoThe 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()))
            56. Patient.identifier:cpf.period
            Definition

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

            ShortTime period when id is/was valid for use
            Control0..01
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. Patient.identifier:cpf.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..01
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. Patient.identifier:cns
            Slice Namecns
            Definition

            An identifier for this patient.

            ShortIdentificação pelo Cartão Nacional de SaúdeAn identifier for this patient
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control10..1*
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

            Patients are almost always assigned specific numerical identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Patient.identifier:cns.extension
            Definition

            An Extension


            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.

            ShortExtensionAdditional 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..0*
            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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 64. Patient.identifier:cns.use
              Definition

              The purpose of this identifier.

              Shortusual | official | temp | secondary | old (If known)
              Comments

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

              Control0..01
              BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
              (required to http://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()))
              66. Patient.identifier:cns.type
              Definition

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

              ShortDescription 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..01
              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
              (extensible to http://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()))
              68. Patient.identifier:cns.system
              Definition

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

              ShortO identificador do sistema de identificaçãoThe 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.

              Pattern Valuehttps://fhir.saude.go.gov.br/sid/cns
              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()))
              70. Patient.identifier:cns.value
              Definition

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

              ShortNúmero do Cartão Nacional de Saúde do indivíduoThe 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()))
              72. Patient.identifier:cns.period
              Definition

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

              ShortTime period when id is/was valid for use
              Control0..01
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. Patient.identifier:cns.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..01
              TypeReference(Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. Patient.active
              Definition

              Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

              It is often used to filter patient lists to exclude inactive patients

              Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

              ShortWhether this patient's record is in active use
              Comments

              If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

              Control0..01
              Typeboolean
              Is Modifiertrue because 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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need to be able to mark a patient record as not to be used because it was created in error.

              Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. Patient.name
              Definition

              A name associated with the individual.

              ShortNome(s) utilizado(s) pelo indivíduoA name associated with the patient
              Comments

              A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

              Control10..2*
              TypeHumanName(Nome do cidadão)
              Is Modifierfalse
              Summarytrue
              Requirements

              Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

              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 Patient.name. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • pattern @ use
              • 80. Patient.name:official
                Slice Nameofficial
                Definition

                A name associated with the individual.

                ShortNome oficial do indivíduoA name associated with the patient
                Comments

                A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                Control10..1*
                TypeHumanName(Nome do cidadão)
                Is Modifierfalse
                Summarytrue
                Requirements

                Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                82. Patient.name:official.extension
                Definition

                An Extension


                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.

                ShortExtensionAdditional 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..0*
                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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 84. Patient.name:official.use
                  Definition

                  Identifies the purpose for this name.

                  ShortCódigo que identifica o tipo de nome informadousual | official | temp | nickname | anonymous | old | maiden
                  Comments

                  Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                  Control10..1
                  BindingThe codes SHALL be taken from Tipo de uso do nome do cidadãohttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                  (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

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

                  Pattern Valueofficial
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  86. Patient.name:official.text
                  Definition

                  Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                  ShortRepresentação de texto do nome completo do indivíduoText representation of the full name
                  Comments

                  Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                  A renderable, unencoded form.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  88. Patient.name:official.family
                  Definition

                  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                  ShortFamily name (often called 'Surname')
                  Comments

                  Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                  Control0..01
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate Namessurname
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  90. Patient.name:official.given
                  Definition

                  Given name.

                  ShortGiven names (not always 'first'). Includes middle names
                  Comments

                  If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                  Control0..0*
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate Namesfirst name, middle name
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  92. Patient.name:official.prefix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                  ShortParts that come before the name
                  Control0..0*
                  Typestring
                  Is Modifierfalse
                  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()))
                  94. Patient.name:official.suffix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                  ShortParts that come after the name
                  Control0..0*
                  Typestring
                  Is Modifierfalse
                  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()))
                  96. Patient.name:official.period
                  Definition

                  Indicates the period of time when this name was valid for the named person.

                  ShortTime period when name was/is in use
                  Control0..01
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows names to be placed in historical context.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  98. Patient.name:usual
                  Slice Nameusual
                  Definition

                  A name associated with the individual.

                  ShortNome social do indivíduoA name associated with the patient
                  Comments

                  A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                  Control0..1*
                  TypeHumanName(Nome do cidadão)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  100. Patient.name:usual.extension
                  Definition

                  An Extension


                  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.

                  ShortExtensionAdditional 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..0*
                  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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 102. Patient.name:usual.use
                    Definition

                    Identifies the purpose for this name.

                    ShortCódigo que identifica o tipo de nome informadousual | official | temp | nickname | anonymous | old | maiden
                    Comments

                    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                    Control10..1
                    BindingThe codes SHALL be taken from Tipo de uso do nome do cidadãohttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                    (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

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

                    Pattern Valueusual
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    104. Patient.name:usual.text
                    Definition

                    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                    ShortRepresentação de texto do nome completo do indivíduoText representation of the full name
                    Comments

                    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                    A renderable, unencoded form.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    106. Patient.name:usual.family
                    Definition

                    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                    ShortFamily name (often called 'Surname')
                    Comments

                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                    Control0..01
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate Namessurname
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    108. Patient.name:usual.given
                    Definition

                    Given name.

                    ShortGiven names (not always 'first'). Includes middle names
                    Comments

                    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                    Control0..0*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate Namesfirst name, middle name
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    110. Patient.name:usual.prefix
                    Definition

                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                    ShortParts that come before the name
                    Control0..0*
                    Typestring
                    Is Modifierfalse
                    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()))
                    112. Patient.name:usual.suffix
                    Definition

                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                    ShortParts that come after the name
                    Control0..0*
                    Typestring
                    Is Modifierfalse
                    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()))
                    114. Patient.name:usual.period
                    Definition

                    Indicates the period of time when this name was valid for the named person.

                    ShortTime period when name was/is in use
                    Control0..01
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows names to be placed in historical context.

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

                    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                    ShortMeio(s) para entrar em contato com o indivíduoA contact detail for the individual
                    Comments

                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                    Control10..*
                    TypeContactPoint
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    People have (primary) ways to contact them in some way such as phone, email.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    NumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                    EmailValido: Máscara de email xxx@xxx.xx ($this.where(system = 'email').select(value).all(matches('^([\\w-\\.]+){1,64}@([\\w&&[^_]]+){2,255}(.[a-z]{2,}){1,}$')))
                    SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • pattern @ system
                    • 118. Patient.telecom:phone
                      Slice Namephone
                      Definition

                      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                      ShortTelefone do indivíduoA contact detail for the individual
                      Comments

                      A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                      Control0..*
                      TypeContactPoint
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      People have (primary) ways to contact them in some way such as phone, email.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      120. Patient.telecom:phone.extension
                      Definition

                      An Extension


                      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.

                      ShortExtensionAdditional 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..0*
                      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 Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 122. Patient.telecom:phone.system
                        Definition

                        Telecommunications form for contact point - what communications system is required to make use of the contact.

                        ShortSistema de códigos que define o tipo de meio de contatophone | fax | email | pager | url | sms | other
                        Control10..1
                        This element is affected by the following invariants: cpt-2
                        BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                        Sistema de comunicação


                        Telecommunications form for contact point.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Pattern Valuephone
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. Patient.telecom:phone.value
                        Definition

                        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                        ShortValor do meio de contatoThe actual contact point details
                        Comments

                        Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                        Need to support legacy numbers that are not in a tightly controlled format.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. Patient.telecom:phone.use
                        Definition

                        Identifies the purpose for the contact point.

                        Shorthome | work | temp | old | mobile - purpose of this contact point
                        Comments

                        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                        Control0..01
                        BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                        Use of contact point.

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

                        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. Patient.telecom:phone.rank
                        Definition

                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                        ShortSpecify preferred order of use (1 = highest)
                        Comments

                        Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                        Control0..01
                        TypepositiveInt
                        Is Modifierfalse
                        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()))
                        130. Patient.telecom:phone.period
                        Definition

                        Time period when the contact point was/is in use.

                        ShortTime period when the contact point was/is in use
                        Control0..01
                        TypePeriod
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. Patient.telecom:email
                        Slice Nameemail
                        Definition

                        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                        ShortEmail do indivíduoA contact detail for the individual
                        Comments

                        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                        Control0..*
                        TypeContactPoint
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        People have (primary) ways to contact them in some way such as phone, email.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. Patient.telecom:email.extension
                        Definition

                        An Extension


                        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.

                        ShortExtensionAdditional 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..0*
                        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 Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 136. Patient.telecom:email.system
                          Definition

                          Telecommunications form for contact point - what communications system is required to make use of the contact.

                          ShortSistema de códigos que define o tipo de meio de contatophone | fax | email | pager | url | sms | other
                          Control10..1
                          This element is affected by the following invariants: cpt-2
                          BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                          Sistema de comunicação


                          Telecommunications form for contact point.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Pattern Valueemail
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          138. Patient.telecom:email.value
                          Definition

                          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                          ShortValor do meio de contatoThe actual contact point details
                          Comments

                          Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                          Need to support legacy numbers that are not in a tightly controlled format.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          140. Patient.telecom:email.use
                          Definition

                          Identifies the purpose for the contact point.

                          Shorthome | work | temp | old | mobile - purpose of this contact point
                          Comments

                          Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                          Control0..01
                          BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                          Use of contact point.

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

                          Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          142. Patient.telecom:email.rank
                          Definition

                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                          ShortSpecify preferred order of use (1 = highest)
                          Comments

                          Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                          Control0..01
                          TypepositiveInt
                          Is Modifierfalse
                          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()))
                          144. Patient.telecom:email.period
                          Definition

                          Time period when the contact point was/is in use.

                          ShortTime period when the contact point was/is in use
                          Control0..01
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          146. Patient.gender
                          Definition

                          Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                          Shortmale | female | other | unknown
                          Comments

                          The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                          Control10..1
                          BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
                          (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                          Código que identifica o sexo do indivíduo, conforme documento oficial


                          The gender of a person used for administrative purposes.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Needed for identification of the individual, in combination with (at least) name and birth date.

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

                          The date of birth for the individual.

                          ShortData em que o indivíduo nasceu, conforme documento oficialThe date of birth for the individual
                          Comments

                          At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

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

                          Age of the individual drives many clinical processes.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          DataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
                          LOINC Code21112-8
                          150. Patient.deceased[x]
                          Definition

                          Indicates if the individual is deceased or not.

                          ShortIndicates if the individual is deceased or not
                          Comments

                          If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                          Control0..01
                          TypeChoice of: boolean, dateTime
                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

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

                          An address for the individual.

                          ShortEndereço de residência do indivíduoAn address for the individual
                          Comments

                          Patient may have multiple addresses with different uses or applicable periods.

                          Control10..1*
                          TypeAddress
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          154. Patient.address.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..01
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          156. Patient.address.extension
                          Definition

                          An Extension


                          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.

                          ShortExtensionAdditional 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..0*
                          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 Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 158. Patient.address.use
                            Definition

                            The purpose of this address.

                            ShortCódigo que identifica o tipo de endereço informadohome | work | temp | old | billing - purpose of this address
                            Comments

                            Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                            Control10..1
                            BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                            The use of an address.

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

                            Allows an appropriate address to be chosen from a list of many.

                            Pattern Valuehome
                            Example<br/><b>General</b>:home
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            160. Patient.address.type
                            Definition

                            Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                            Shortpostal | physical | both
                            Comments

                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                            Control0..01
                            BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                            (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                            The type of an address (physical / postal).

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Example<br/><b>General</b>:both
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            162. Patient.address.text
                            Definition

                            Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                            ShortText representation of the address
                            Comments

                            Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                            A renderable, unencoded form.

                            Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            164. Patient.address.line
                            Definition

                            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                            ShortElementos necessários ao endereçamento brasileiroStreet name, number, direction & P.O. Box etc.
                            Control0..5*
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Example<br/><b>General</b>:137 Nowhere Street
                            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 Patient.address.line. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                            • value @ extension.value
                            • 166. Patient.address.line:bairro
                              Slice Namebairro
                              Definition

                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                              ShortBairro da residência do indivíduoStreet name, number, direction & P.O. Box etc.
                              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>:137 Nowhere Street
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              168. Patient.address.line:logradouro
                              Slice Namelogradouro
                              Definition

                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                              ShortNome do logradouro da residência do indivíduoStreet name, number, direction & P.O. Box etc.
                              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>:137 Nowhere Street
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              170. Patient.address.line:numero
                              Slice Namenumero
                              Definition

                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                              ShortNúmero da residência do indivíduoStreet name, number, direction & P.O. Box etc.
                              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>:137 Nowhere Street
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              172. Patient.address.line:complemento
                              Slice Namecomplemento
                              Definition

                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                              ShortComplemento do endereço da residência do indivíduoStreet name, number, direction & P.O. Box etc.
                              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>:137 Nowhere Street
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              174. Patient.address.line:tipologradouro
                              Slice Nametipologradouro
                              Definition

                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                              ShortTipo de logradouro da residência do indivíduoStreet name, number, direction & P.O. Box etc.
                              Control0..1*
                              BindingThe codes SHALL be taken from For codes, see Tipo de Logradouro
                              (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/tipo-logradouro)
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Example<br/><b>General</b>:137 Nowhere Street
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              176. Patient.address.city
                              Definition

                              The name of the city, town, suburb, village or other community or delivery center.

                              ShortMunicípio de residência do indivíduoName of city, town etc.
                              Control10..1
                              BindingThe codes SHALL be taken from For codes, see Município
                              (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate NamesMunicpality
                              Example<br/><b>General</b>:Erewhon
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              178. Patient.address.district
                              Definition

                              The name of the administrative area (county).

                              ShortDistrict name (aka county)
                              Comments

                              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate NamesCounty
                              Example<br/><b>General</b>:Madison
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              180. Patient.address.state
                              Definition

                              Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                              ShortSub-unit of country (abbreviations ok)
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate NamesProvince, Territory
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              182. Patient.address.postalCode
                              Definition

                              A postal code designating a region defined by the postal service.

                              ShortCódigo de Endereçamento Postal da residência do indivíduoPostal code for area
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate NamesZip
                              Example<br/><b>General</b>:9132
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              184. Patient.address.country
                              Definition

                              Country - a nation as commonly understood or generally accepted.

                              ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                              Comments

                              ISO 3166 3 letter codes can be used in place of a human readable country name.

                              Control0..01
                              Typestring
                              Is Modifierfalse
                              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()))
                              186. Patient.address.period
                              Definition

                              Time period when address was/is in use.

                              ShortTime period when address was/is in use
                              Control0..01
                              TypePeriod
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Allows addresses to be placed in historical context.

                              Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              188. Patient.maritalStatus
                              Definition

                              This field contains a patient's most recent marital (civil) status.

                              ShortEstado civil do indivíduoMarital (civil) status of a patient
                              Control0..1
                              BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Estado Civilhttp://hl7.org/fhir/ValueSet/marital-status
                              (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/estado-civil)
                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Most, if not all systems capture it.

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

                              A reference to a code defined by a terminology system.

                              ShortCodificação que representa o estado civil de um indivíduoCode defined by a terminology system
                              Comments

                              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.

                              Control0..*
                              TypeCoding
                              Is Modifierfalse
                              Summarytrue
                              Requirements

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              192. Patient.maritalStatus.coding.system
                              Definition

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

                              ShortSistema de códigos que define o estado civil de um indivíduoIdentity of the terminology system
                              Comments

                              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.

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

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              194. Patient.maritalStatus.coding.code
                              Definition

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

                              ShortCódigo que identifica o estado civil do indivíduoSymbol in syntax defined by the system
                              Control0..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              196. Patient.multipleBirth[x]
                              Definition

                              Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                              ShortWhether patient is part of a multiple birth
                              Comments

                              Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                              Control0..01
                              TypeChoice of: boolean, integer
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

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

                              Image of the patient.

                              ShortFotografia do indivíduoImage of the patient
                              Comments

                              Guidelines:

                              • Use id photos, not clinical photos.
                              • Limit dimensions to thumbnail.
                              • Keep byte count low to ease resource updates.
                              Control0..1*
                              TypeAttachment
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

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

                              Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                              ShortMime type of the content, with charset etc.
                              Control10..1
                              BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/mimetypes)
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Processors of the data need to be able to know how to interpret the data.

                              Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              202. Patient.photo.language
                              Definition

                              The human language of the content. The value can be any valid value according to BCP 47.

                              ShortHuman language of the content (BCP-47)
                              Control0..01
                              BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
                              (preferred to http://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
                              Summarytrue
                              Requirements

                              Users need to be able to choose between the languages in a set of attachments.

                              Example<br/><b>General</b>:en-AU
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              204. Patient.photo.data
                              Definition

                              The actual data of the attachment - a sequence of bytes, base64 encoded.

                              ShortData inline, base64ed
                              Comments

                              The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

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

                              The data needs to able to be transmitted inline.

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

                              A location where the data can be accessed.

                              ShortUri where the data can be found
                              Comments

                              If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                              The data needs to be transmitted by reference.

                              Example<br/><b>General</b>:http://www.acme.com/logo-small.png
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              208. Patient.photo.size
                              Definition

                              The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                              ShortNumber of bytes of content (if url provided)
                              Comments

                              The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                              Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

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

                              The calculated hash of the data using SHA-1. Represented using base64.

                              ShortHash of the data (sha-1, base64ed)
                              Comments

                              The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.


                              The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                              Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

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

                              A label or set of text to display in place of the data.

                              ShortLabel to display in place of the data
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                              Example<br/><b>General</b>:Official Corporate Logo
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              214. Patient.photo.creation
                              Definition

                              The date that the attachment was first created.

                              ShortDate attachment was first created
                              Control0..01
                              TypedateTime
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              This is often tracked as an integrity issue for use of the attachment.

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

                              A contact party (e.g. guardian, partner, friend) for the patient.

                              ShortPessoa(s) de referência do indivíduo a ser(em) contactada(s) em caso de necessidadeA contact party (e.g. guardian, partner, friend) for the patient
                              Comments

                              Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                              Control0..*
                              TypeBackboneElement
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Need to track people you can contact about the patient.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                              pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                              218. Patient.contact.modifierExtension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              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 element that contains them
                              Summarytrue
                              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, modifiers
                              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())
                              220. Patient.contact.relationship
                              Definition

                              The nature of the relationship between the patient and the contact person.

                              ShortTipo de relacionamento do indivíduo com a pessoa de referênciaThe kind of relationship
                              Control10..1*
                              BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                              (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                              The nature of the relationship between a patient and a contact person for that patient.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Used to determine which contact person is the most relevant to approach, depending on circumstances.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              222. Patient.contact.relationship.coding
                              Definition

                              A reference to a code defined by a terminology system.

                              ShortCodificação que representa o tipo de relacionamento do indivíduo com a pessoa de referênciaCode defined by a terminology system
                              Comments

                              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.

                              Control10..1*
                              BindingThe codes SHALL be taken from For codes, see RelacaoContato
                              (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/relacao-contato)
                              TypeCoding
                              Is Modifierfalse
                              Summarytrue
                              Requirements

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              224. Patient.contact.relationship.coding.system
                              Definition

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

                              ShortSistema de códigos que define o tipo de relacionamento do indivíduo com a pessoa de referênciaIdentity of the terminology system
                              Comments

                              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.

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

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              226. Patient.contact.relationship.coding.code
                              Definition

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

                              ShortCódigo que identifica o tipo de relacionamento do indivíduo com a pessoa de referênciaSymbol in syntax defined by the system
                              Control0..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

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

                              A name associated with the contact person.

                              ShortNome utilizado pela pessoa de referênciaA name associated with the contact person
                              Control10..1
                              TypeHumanName
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              230. Patient.contact.name.use
                              Definition

                              Identifies the purpose for this name.

                              Shortusual | official | temp | nickname | anonymous | old | maiden
                              Comments

                              Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                              Control0..01
                              BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                              The use of a human name.

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

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              232. Patient.contact.name.text
                              Definition

                              Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                              ShortRepresentação de texto do nome completo da pessoa de referêciaText representation of the full name
                              Comments

                              Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                              A renderable, unencoded form.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              234. Patient.contact.name.family
                              Definition

                              The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                              ShortFamily name (often called 'Surname')
                              Comments

                              Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate Namessurname
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              236. Patient.contact.name.given
                              Definition

                              Given name.

                              ShortGiven names (not always 'first'). Includes middle names
                              Comments

                              If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                              Control0..0*
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Alternate Namesfirst name, middle name
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              238. Patient.contact.name.prefix
                              Definition

                              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                              ShortParts that come before the name
                              Control0..0*
                              Typestring
                              Is Modifierfalse
                              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()))
                              240. Patient.contact.name.suffix
                              Definition

                              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                              ShortParts that come after the name
                              Control0..0*
                              Typestring
                              Is Modifierfalse
                              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()))
                              242. Patient.contact.name.period
                              Definition

                              Indicates the period of time when this name was valid for the named person.

                              ShortTime period when name was/is in use
                              Control0..01
                              TypePeriod
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Allows names to be placed in historical context.

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

                              A contact detail for the person, e.g. a telephone number or an email address.

                              ShortMeio(s) para entrar em contato com a pessoa de referênciaA contact detail for the person
                              Comments

                              Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                              Control0..1*
                              TypeContactPoint
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              People have (primary) ways to contact them in some way such as phone, email.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              NumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                              246. Patient.contact.telecom.system
                              Definition

                              Telecommunications form for contact point - what communications system is required to make use of the contact.

                              ShortCódigo que identifica o tipo de meio de contato utilizado para entrar em contato com a pessoa de referênciaphone | fax | email | pager | url | sms | other
                              Control10..1
                              This element is affected by the following invariants: cpt-2
                              BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                              Telecommunications form for contact point.

                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Pattern Valuephone
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              248. Patient.contact.telecom.value
                              Definition

                              The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                              ShortValor do meio de contato da pessoa de referênciaThe actual contact point details
                              Comments

                              Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                              Need to support legacy numbers that are not in a tightly controlled format.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              250. Patient.contact.telecom.use
                              Definition

                              Identifies the purpose for the contact point.

                              Shorthome | work | temp | old | mobile - purpose of this contact point
                              Comments

                              Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                              Control0..1
                              BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                              Use of contact point.

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

                              Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

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

                              Address for the contact person.

                              ShortAddress for the contact person
                              Control0..01
                              TypeAddress
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              Need to keep track where the contact person can be contacted per postal mail or visited.

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

                              Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                              Shortmale | female | other | unknown
                              Control0..01
                              BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                              The gender of a person used for administrative purposes.

                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              Needed to address the person correctly.

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

                              Organization on behalf of which the contact is acting or for which the contact is working.

                              ShortOrganization that is associated with the contact
                              Control0..01
                              This element is affected by the following invariants: pat-1
                              TypeReference(Organization)
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              For guardians or business related contacts, the organization is relevant.

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

                              The period during which this contact person or organization is valid to be contacted relating to this patient.

                              ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                              Control0..01
                              TypePeriod
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              260. Patient.communication
                              Definition

                              A language which may be used to communicate with the patient about his or her health.

                              ShortA language which may be used to communicate with the patient about his or her health
                              Comments

                              If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                              Control0..0*
                              TypeBackboneElement
                              Is Modifierfalse
                              Summaryfalse
                              Requirements

                              If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

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

                              Patient's nominated care provider.

                              ShortPatient's nominated primary care provider
                              Comments

                              This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                              Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                              Control0..0*
                              TypeReference(Organization, Practitioner, PractitionerRole)
                              Is Modifierfalse
                              Summaryfalse
                              Alternate NamescareProvider
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              266. Patient.managingOrganization
                              Definition

                              Organization that is the custodian of the patient record.

                              ShortOrganization that is the custodian of the patient record
                              Comments

                              There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                              Control0..01
                              TypeReference(Organization)
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Need to know who recognizes this patient record, manages and updates it.

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

                              Link to another patient resource that concerns the same actual patient.

                              ShortLink to another patient resource that concerns the same actual person
                              Comments

                              There is no assumption that linked patient records have mutual links.

                              Control0..0*
                              TypeBackboneElement
                              Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                              Summarytrue
                              Requirements

                              There are multiple use cases:

                              • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                              • Distribution of patient information across multiple servers.
                              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. Patient
                              ShortDados demográficos do indivíduo
                              InvariantsNoMaximoUmaMaeBiologica: Deve existir no máximo uma mãe biológica. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0101').count() <= 1)
                              NoMaximoUmPaiBiologico: Deve existir no máximo um pai biológico. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0201').count() <= 1)
                              BrasileiroSeSomenteSeNasceNoBrasil: Brasileiro SE SOMENTE SE nasce no Brasil. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country = '10').exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country != '10').exists())
                              CidadeNascimento: Brasileiro informa a cidade de nascimento. Não brasileiro não informa a cidade de nascimento. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists().not())
                              ContatoEmergenciaUnico: Contato de emergência não deve ter duplicidades (contact.select(telecom).select(value).isDistinct())
                              2. Patient.extension
                              Control4..?
                              SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 4. Patient.extension:raca
                                Slice Nameraca
                                Control1..1
                                TypeExtension(Raça/Cor e Etnina) (Complex Extension)
                                6. Patient.extension:orientacaoSexual
                                Slice NameorientacaoSexual
                                Control0..1
                                TypeExtension(Orientação Sexual) (Extension Type: code)
                                8. Patient.extension:filiacao
                                Slice Namefiliacao
                                Control1..4
                                TypeExtension(Filiação) (Complex Extension)
                                10. Patient.extension:povosComunidadesTradicionais
                                Slice NamepovosComunidadesTradicionais
                                Control0..*
                                TypeExtension(Povos e comunidades tradicionais) (Extension Type: code)
                                12. Patient.extension:nacionalidade
                                Slice Namenacionalidade
                                Control1..1
                                TypeExtension(Nacionalidade) (Extension Type: CodeableConcept)
                                14. Patient.extension:localNascimento
                                Slice NamelocalNascimento
                                Control1..1
                                TypeExtension(Patient Birth Place) (Extension Type: Address)
                                16. Patient.extension:localNascimento.value[x]
                                TypeAddress(Local Nascimento)
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                18. Patient.extension:identidadeGenero
                                Slice NameidentidadeGenero
                                Control0..1
                                TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
                                20. Patient.extension:identidadeGenero.value[x]
                                BindingThe codes SHALL be taken from Identidade de gênero
                                (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/identidade-genero)
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                22. Patient.extension:biometria
                                Slice Namebiometria
                                Control0..*
                                TypeExtension(Biometria) (Complex Extension)
                                24. Patient.extension:ocupacao
                                Slice Nameocupacao
                                Control0..*
                                TypeExtension(Ocupacao) (Extension Type: Reference(Ocupacao))
                                26. Patient.extension:escolaridade
                                Slice Nameescolaridade
                                Control0..1
                                TypeExtension(Escolaridade) (Extension Type: Reference(Escolaridade))
                                28. Patient.extension:situacaoMercadoTrabalho
                                Slice NamesituacaoMercadoTrabalho
                                Control0..1
                                TypeExtension(Ocupacao) (Extension Type: Reference(SituacaoMercadoTrabalho))
                                30. Patient.identifier
                                ShortNúmero de documento que identifica o cidadão
                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control2..2
                                SlicingThis element introduces a set of slices on Patient.identifier. The slices areOrdered and Closed, and can be differentiated using the following discriminators:
                                • pattern @ system
                                • 32. Patient.identifier:cpf
                                  Slice Namecpf
                                  ShortIdentificação pelo Cadastro de Pessoas Físicas
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control1..1
                                  34. Patient.identifier:cpf.extension
                                  Control0..0
                                  36. Patient.identifier:cpf.use
                                  Control0..0
                                  38. Patient.identifier:cpf.type
                                  Control0..0
                                  40. Patient.identifier:cpf.system
                                  ShortO identificador do sistema de identificação
                                  Control1..?
                                  Pattern Valuehttps://fhir.saude.go.gov.br/sid/cpf
                                  42. Patient.identifier:cpf.value
                                  ShortNúmero do Cadastro de Pessoas Físicas do indivíduo
                                  Control1..?
                                  44. Patient.identifier:cpf.period
                                  Control0..0
                                  46. Patient.identifier:cpf.assigner
                                  Control0..0
                                  48. Patient.identifier:cns
                                  Slice Namecns
                                  ShortIdentificação pelo Cartão Nacional de Saúde
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control1..1
                                  50. Patient.identifier:cns.extension
                                  Control0..0
                                  52. Patient.identifier:cns.use
                                  Control0..0
                                  54. Patient.identifier:cns.type
                                  Control0..0
                                  56. Patient.identifier:cns.system
                                  ShortO identificador do sistema de identificação
                                  Control1..?
                                  Pattern Valuehttps://fhir.saude.go.gov.br/sid/cns
                                  58. Patient.identifier:cns.value
                                  ShortNúmero do Cartão Nacional de Saúde do indivíduo
                                  Control1..?
                                  60. Patient.identifier:cns.period
                                  Control0..0
                                  62. Patient.identifier:cns.assigner
                                  Control0..0
                                  64. Patient.active
                                  Control0..0
                                  66. Patient.name
                                  ShortNome(s) utilizado(s) pelo indivíduo
                                  Control1..2
                                  TypeHumanName(Nome do cidadão)
                                  SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                  • pattern @ use
                                  • 68. Patient.name:official
                                    Slice Nameofficial
                                    ShortNome oficial do indivíduo
                                    Control1..1
                                    TypeHumanName(Nome do cidadão)
                                    70. Patient.name:official.use
                                    ShortCódigo que identifica o tipo de nome informado
                                    Control1..?
                                    Pattern Valueofficial
                                    72. Patient.name:official.text
                                    ShortRepresentação de texto do nome completo do indivíduo
                                    74. Patient.name:usual
                                    Slice Nameusual
                                    ShortNome social do indivíduo
                                    Control0..1
                                    TypeHumanName(Nome do cidadão)
                                    76. Patient.name:usual.use
                                    ShortCódigo que identifica o tipo de nome informado
                                    Control1..?
                                    Pattern Valueusual
                                    78. Patient.name:usual.text
                                    ShortRepresentação de texto do nome completo do indivíduo
                                    80. Patient.telecom
                                    ShortMeio(s) para entrar em contato com o indivíduo
                                    Control1..?
                                    InvariantsNumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                                    EmailValido: Máscara de email xxx@xxx.xx ($this.where(system = 'email').select(value).all(matches('^([\\w-\\.]+){1,64}@([\\w&&[^_]]+){2,255}(.[a-z]{2,}){1,}$')))
                                    SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • pattern @ system
                                    • 82. Patient.telecom:phone
                                      Slice Namephone
                                      ShortTelefone do indivíduo
                                      Control0..*
                                      84. Patient.telecom:phone.extension
                                      Control0..0
                                      86. Patient.telecom:phone.system
                                      ShortSistema de códigos que define o tipo de meio de contato
                                      Control1..?
                                      BindingThe codes SHALL be taken from ContactPointSystem
                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                      Sistema de comunicação

                                      Pattern Valuephone
                                      88. Patient.telecom:phone.value
                                      ShortValor do meio de contato
                                      Control1..?
                                      90. Patient.telecom:phone.use
                                      Control0..0
                                      92. Patient.telecom:phone.rank
                                      Control0..0
                                      94. Patient.telecom:phone.period
                                      Control0..0
                                      96. Patient.telecom:email
                                      Slice Nameemail
                                      ShortEmail do indivíduo
                                      Control0..*
                                      98. Patient.telecom:email.extension
                                      Control0..0
                                      100. Patient.telecom:email.system
                                      ShortSistema de códigos que define o tipo de meio de contato
                                      Control1..?
                                      BindingThe codes SHALL be taken from ContactPointSystem
                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                      Sistema de comunicação

                                      Pattern Valueemail
                                      102. Patient.telecom:email.value
                                      ShortValor do meio de contato
                                      Control1..?
                                      104. Patient.telecom:email.use
                                      Control0..0
                                      106. Patient.telecom:email.rank
                                      Control0..0
                                      108. Patient.telecom:email.period
                                      Control0..0
                                      110. Patient.gender
                                      Control1..?
                                      BindingThe codes SHALL be taken from AdministrativeGender
                                      (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                      Código que identifica o sexo do indivíduo, conforme documento oficial

                                      112. Patient.birthDate
                                      ShortData em que o indivíduo nasceu, conforme documento oficial
                                      Control1..?
                                      InvariantsDataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
                                      LOINC Code
                                      114. Patient.deceased[x]
                                      Control0..0
                                      116. Patient.address
                                      ShortEndereço de residência do indivíduo
                                      Control1..1
                                      118. Patient.address.id
                                      Control0..0
                                      120. Patient.address.extension
                                      Control0..0
                                      122. Patient.address.use
                                      ShortCódigo que identifica o tipo de endereço informado
                                      Control1..?
                                      Pattern Valuehome
                                      124. Patient.address.type
                                      Control0..0
                                      126. Patient.address.text
                                      Control0..0
                                      128. Patient.address.line
                                      ShortElementos necessários ao endereçamento brasileiro
                                      Control0..5
                                      SlicingThis element introduces a set of slices on Patient.address.line. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                      • value @ extension.value
                                      • 130. Patient.address.line.extension
                                        132. Patient.address.line.extension.url
                                        Pattern Valuehttps://fhir.saude.go.gov.br/r4/core/StructureDefinition/tipo-informacao-endereco
                                        134. Patient.address.line:bairro
                                        Slice Namebairro
                                        ShortBairro da residência do indivíduo
                                        Control0..1
                                        136. Patient.address.line:bairro.extension
                                        138. Patient.address.line:bairro.extension.extension
                                        Control0..0
                                        140. Patient.address.line:bairro.extension.value[x]
                                        Typecode
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • type @ $this
                                        • 142. Patient.address.line:bairro.extension.value[x]:valueCode
                                          Slice NamevalueCode
                                          Control0..1
                                          Typecode
                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Pattern Valuebairro
                                          144. Patient.address.line:logradouro
                                          Slice Namelogradouro
                                          ShortNome do logradouro da residência do indivíduo
                                          Control0..1
                                          146. Patient.address.line:logradouro.extension
                                          148. Patient.address.line:logradouro.extension.extension
                                          Control0..0
                                          150. Patient.address.line:logradouro.extension.value[x]
                                          Typecode
                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • type @ $this
                                          • 152. Patient.address.line:logradouro.extension.value[x]:valueCode
                                            Slice NamevalueCode
                                            Control0..1
                                            Typecode
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Pattern Valuelogradouro
                                            154. Patient.address.line:numero
                                            Slice Namenumero
                                            ShortNúmero da residência do indivíduo
                                            Control0..1
                                            156. Patient.address.line:numero.extension
                                            158. Patient.address.line:numero.extension.extension
                                            Control0..0
                                            160. Patient.address.line:numero.extension.value[x]
                                            Typecode
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • type @ $this
                                            • 162. Patient.address.line:numero.extension.value[x]:valueCode
                                              Slice NamevalueCode
                                              Control0..1
                                              Typecode
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Pattern Valuenumero
                                              164. Patient.address.line:complemento
                                              Slice Namecomplemento
                                              ShortComplemento do endereço da residência do indivíduo
                                              Control0..1
                                              166. Patient.address.line:complemento.extension
                                              168. Patient.address.line:complemento.extension.extension
                                              Control0..0
                                              170. Patient.address.line:complemento.extension.value[x]
                                              Typecode
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • type @ $this
                                              • 172. Patient.address.line:complemento.extension.value[x]:valueCode
                                                Slice NamevalueCode
                                                Control0..1
                                                Typecode
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Pattern Valuecomplemento
                                                174. Patient.address.line:tipologradouro
                                                Slice Nametipologradouro
                                                ShortTipo de logradouro da residência do indivíduo
                                                Control0..1
                                                BindingThe codes SHALL be taken from Tipo de Logradouro
                                                (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/tipo-logradouro)
                                                176. Patient.address.line:tipologradouro.extension
                                                178. Patient.address.line:tipologradouro.extension.extension
                                                Control0..0
                                                180. Patient.address.line:tipologradouro.extension.value[x]
                                                Typecode
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • type @ $this
                                                • 182. Patient.address.line:tipologradouro.extension.value[x]:valueCode
                                                  Slice NamevalueCode
                                                  Control0..1
                                                  Typecode
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Pattern Valuetipologradouro
                                                  184. Patient.address.city
                                                  ShortMunicípio de residência do indivíduo
                                                  Control1..?
                                                  BindingThe codes SHALL be taken from Município
                                                  (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)
                                                  186. Patient.address.district
                                                  Control0..0
                                                  188. Patient.address.state
                                                  Control0..0
                                                  190. Patient.address.postalCode
                                                  ShortCódigo de Endereçamento Postal da residência do indivíduo
                                                  192. Patient.address.country
                                                  Control0..0
                                                  194. Patient.address.period
                                                  Control0..0
                                                  196. Patient.maritalStatus
                                                  ShortEstado civil do indivíduo
                                                  BindingThe codes SHALL be taken from Estado Civil
                                                  (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/estado-civil)
                                                  198. Patient.maritalStatus.coding
                                                  ShortCodificação que representa o estado civil de um indivíduo
                                                  200. Patient.maritalStatus.coding.system
                                                  ShortSistema de códigos que define o estado civil de um indivíduo
                                                  202. Patient.maritalStatus.coding.code
                                                  ShortCódigo que identifica o estado civil do indivíduo
                                                  204. Patient.multipleBirth[x]
                                                  Control0..0
                                                  206. Patient.photo
                                                  ShortFotografia do indivíduo
                                                  Control0..1
                                                  208. Patient.photo.contentType
                                                  Control1..?
                                                  BindingThe codes SHALL be taken from Mime Types
                                                  (required to http://hl7.org/fhir/ValueSet/mimetypes)
                                                  210. Patient.photo.language
                                                  Control0..0
                                                  212. Patient.photo.data
                                                  Control1..?
                                                  214. Patient.photo.url
                                                  Control0..0
                                                  216. Patient.photo.size
                                                  Control0..0
                                                  218. Patient.photo.hash
                                                  Control0..0
                                                  220. Patient.photo.title
                                                  Control0..0
                                                  222. Patient.photo.creation
                                                  Control0..0
                                                  224. Patient.contact
                                                  ShortPessoa(s) de referência do indivíduo a ser(em) contactada(s) em caso de necessidade
                                                  226. Patient.contact.relationship
                                                  ShortTipo de relacionamento do indivíduo com a pessoa de referência
                                                  Control1..1
                                                  228. Patient.contact.relationship.coding
                                                  ShortCodificação que representa o tipo de relacionamento do indivíduo com a pessoa de referência
                                                  Control1..1
                                                  BindingThe codes SHALL be taken from RelacaoContato
                                                  (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/relacao-contato)
                                                  230. Patient.contact.relationship.coding.system
                                                  ShortSistema de códigos que define o tipo de relacionamento do indivíduo com a pessoa de referência
                                                  232. Patient.contact.relationship.coding.code
                                                  ShortCódigo que identifica o tipo de relacionamento do indivíduo com a pessoa de referência
                                                  234. Patient.contact.name
                                                  ShortNome utilizado pela pessoa de referência
                                                  Control1..?
                                                  236. Patient.contact.name.use
                                                  Control0..0
                                                  238. Patient.contact.name.text
                                                  ShortRepresentação de texto do nome completo da pessoa de referêcia
                                                  Control1..?
                                                  240. Patient.contact.name.family
                                                  Control0..0
                                                  242. Patient.contact.name.given
                                                  Control0..0
                                                  244. Patient.contact.name.prefix
                                                  Control0..0
                                                  246. Patient.contact.name.suffix
                                                  Control0..0
                                                  248. Patient.contact.name.period
                                                  Control0..0
                                                  250. Patient.contact.telecom
                                                  ShortMeio(s) para entrar em contato com a pessoa de referência
                                                  Control0..1
                                                  InvariantsNumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                                                  252. Patient.contact.telecom.system
                                                  ShortCódigo que identifica o tipo de meio de contato utilizado para entrar em contato com a pessoa de referência
                                                  Control1..?
                                                  Pattern Valuephone
                                                  254. Patient.contact.telecom.value
                                                  ShortValor do meio de contato da pessoa de referência
                                                  Control1..?
                                                  256. Patient.contact.address
                                                  Control0..0
                                                  258. Patient.contact.gender
                                                  Control0..0
                                                  260. Patient.contact.organization
                                                  Control0..0
                                                  262. Patient.contact.period
                                                  Control0..0
                                                  264. Patient.communication
                                                  Control0..0
                                                  266. Patient.generalPractitioner
                                                  Control0..0
                                                  268. Patient.managingOrganization
                                                  Control0..0
                                                  270. Patient.link
                                                  Control0..0

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

                                                  0. Patient
                                                  Definition

                                                  Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                                                  ShortDados demográficos do indivíduo
                                                  Control0..*
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate NamesSubjectOfCare Client Resident
                                                  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())
                                                  NoMaximoUmaMaeBiologica: Deve existir no máximo uma mãe biológica. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0101').count() <= 1)
                                                  NoMaximoUmPaiBiologico: Deve existir no máximo um pai biológico. (extension.where(url = 'https://fhir.saude.go.gov.br/r4/core/StructureDefinition/filiacao').extension.where(url = 'tipo' and value='0201').count() <= 1)
                                                  BrasileiroSeSomenteSeNasceNoBrasil: Brasileiro SE SOMENTE SE nasce no Brasil. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country = '10').exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.country != '10').exists())
                                                  CidadeNascimento: Brasileiro informa a cidade de nascimento. Não brasileiro não informa a cidade de nascimento. (extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B'))).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists() or extension.where(url = 'http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNacionalidade' and (value.coding.code in ('B')).not()).exists() and extension.where(url = 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace' and value.city.exists()).exists().not())
                                                  ContatoEmergenciaUnico: Contato de emergência não deve ter duplicidades (contact.select(telecom).select(value).isDistinct())
                                                  2. Patient.id
                                                  Definition

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

                                                  ShortLogical 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
                                                  Typeid
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  4. Patient.meta
                                                  Definition

                                                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                                  ShortMetadata 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. Patient.implicitRules
                                                  Definition

                                                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                  ShortA 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. Patient.language
                                                  Definition

                                                  The base language in which the resource is written.

                                                  ShortLanguage 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 CommonLanguages
                                                  (preferred to http://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. Patient.text
                                                  Definition

                                                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                                  ShortText 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. Patient.contained
                                                  Definition

                                                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                                  ShortContained, 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. Patient.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control4..*
                                                  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 Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 16. Patient.extension:raca
                                                    Slice Nameraca
                                                    Definition

                                                    Dados relacionados à raça/cor e etnia de um indivíduo.

                                                    ShortRaça/Cor e Etnia
                                                    Control1..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Raça/Cor e Etnina) (Complex Extension)
                                                    Is Modifierfalse
                                                    Alternate Namesraça, etnia, cor, cútis
                                                    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. Patient.extension:orientacaoSexual
                                                    Slice NameorientacaoSexual
                                                    Definition

                                                    Extensão para informar a orientação sexual

                                                    ShortOrientação Sexual
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Orientação Sexual) (Extension Type: code)
                                                    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())
                                                    20. Patient.extension:filiacao
                                                    Slice Namefiliacao
                                                    Definition

                                                    Filiação

                                                    ShortFiliação
                                                    Control1..4
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Filiação) (Complex Extension)
                                                    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())
                                                    NomeCompletoDeveConterNoMinimoDoisNomes: Nome deve ser composto por no mínimo nome e sobrenome (extension.where(url = 'nome').value.split(' ').count() > 1)
                                                    22. Patient.extension:povosComunidadesTradicionais
                                                    Slice NamepovosComunidadesTradicionais
                                                    Definition

                                                    Extensão para informar o pertencimento a povos e comunidades tradicionais

                                                    ShortPovos e comunidades tradicionais
                                                    Control0..*
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Povos e comunidades tradicionais) (Extension Type: code)
                                                    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())
                                                    24. Patient.extension:nacionalidade
                                                    Slice Namenacionalidade
                                                    Definition

                                                    An Extension

                                                    ShortNacionalidade
                                                    Control1..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Nacionalidade) (Extension Type: CodeableConcept)
                                                    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())
                                                    26. Patient.extension:localNascimento
                                                    Slice NamelocalNascimento
                                                    Definition

                                                    The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

                                                    ShortPlace of Birth for patient
                                                    Control1..1
                                                    TypeExtension(Patient Birth Place) (Extension Type: Address)
                                                    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())
                                                    28. Patient.extension:localNascimento.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
                                                    This element is affected by the following invariants: ele-1
                                                    Typeid
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    30. Patient.extension:localNascimento.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..0
                                                    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 Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 32. Patient.extension:localNascimento.url
                                                      Definition

                                                      Source of the definition for the extension code - a logical name or a URL.

                                                      Shortidentifies the meaning of the extension
                                                      Comments

                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                      Control1..1
                                                      Typeuri
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace
                                                      34. Patient.extension:localNascimento.value[x]
                                                      Definition

                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                      ShortValue of extension
                                                      Control1..1
                                                      This element is affected by the following invariants: ext-1
                                                      TypeAddress(Local Nascimento)
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      36. Patient.extension:identidadeGenero
                                                      Slice NameidentidadeGenero
                                                      Definition

                                                      The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient.

                                                      ShortThe patient's gender identity
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
                                                      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())
                                                      38. Patient.extension:identidadeGenero.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
                                                      40. Patient.extension:identidadeGenero.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..0
                                                      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 Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 42. Patient.extension:identidadeGenero.url
                                                        Definition

                                                        Source of the definition for the extension code - a logical name or a URL.

                                                        Shortidentifies the meaning of the extension
                                                        Comments

                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                        Control1..1
                                                        Typeuri
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-genderIdentity
                                                        44. Patient.extension:identidadeGenero.value[x]
                                                        Definition

                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                        ShortValue of extension
                                                        Control1..1
                                                        BindingThe codes SHALL be taken from Identidade de gênero
                                                        (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/identidade-genero)
                                                        TypeCodeableConcept
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        46. Patient.extension:biometria
                                                        Slice Namebiometria
                                                        Definition

                                                        Biometria

                                                        ShortBiometria
                                                        Control0..*
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(Biometria) (Complex Extension)
                                                        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())
                                                        48. Patient.extension:ocupacao
                                                        Slice Nameocupacao
                                                        Definition

                                                        Ocupação refere-se à atividade profissional desempenhada por um indivíduo em um determinado campo de trabalho, conforme definido e categorizado pela Classificação Brasileira de Ocupações (CBO). Cada ocupação é identificada por um código específico no CBO, que descreve as principais responsabilidades, habilidades necessárias e condições de trabalho associadas àquela ocupação.

                                                        ShortOcupacao
                                                        Control0..*
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(Ocupacao) (Extension Type: Reference(Ocupacao))
                                                        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())
                                                        50. Patient.extension:escolaridade
                                                        Slice Nameescolaridade
                                                        Definition

                                                        Escolaridade se refere ao nível de educação formal alcançado por um indivíduo, geralmente medido em termos de anos de estudo completados ou de diplomas obtidos. Essa medida é frequentemente usada para avaliar o conhecimento e as habilidades de uma pessoa em um determinado contexto educacional ou profissional.

                                                        ShortEscolaridade
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(Escolaridade) (Extension Type: Reference(Escolaridade))
                                                        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())
                                                        52. Patient.extension:situacaoMercadoTrabalho
                                                        Slice NamesituacaoMercadoTrabalho
                                                        Definition

                                                        Situação no mercado de trabalho se refere ao estado ou condição de emprego de uma pessoa em relação ao ambiente econômico mais amplo..

                                                        ShortOcupacao
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(Ocupacao) (Extension Type: Reference(SituacaoMercadoTrabalho))
                                                        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())
                                                        54. Patient.modifierExtension
                                                        Definition

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

                                                        ShortExtensions 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())
                                                        56. Patient.identifier
                                                        Definition

                                                        An identifier for this patient.

                                                        ShortNúmero de documento que identifica o cidadão
                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control2..2
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Requirements

                                                        Patients are almost always assigned specific numerical identifiers.

                                                        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 Patient.identifier. The slices areOrdered and Closed, and can be differentiated using the following discriminators:
                                                        • pattern @ system
                                                        • 58. Patient.identifier:cpf
                                                          Slice Namecpf
                                                          Definition

                                                          An identifier for this patient.

                                                          ShortIdentificação pelo Cadastro de Pessoas Físicas
                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                          Control1..1
                                                          TypeIdentifier
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Requirements

                                                          Patients are almost always assigned specific numerical identifiers.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          60. Patient.identifier:cpf.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
                                                          62. Patient.identifier:cpf.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..0
                                                          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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 64. Patient.identifier:cpf.use
                                                            Definition

                                                            The purpose of this identifier.

                                                            Shortusual | official | temp | secondary | old (If known)
                                                            Comments

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

                                                            Control0..0
                                                            BindingThe codes SHALL be taken from IdentifierUse
                                                            (required to http://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()))
                                                            66. Patient.identifier:cpf.type
                                                            Definition

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

                                                            ShortDescription 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..0
                                                            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                            (extensible to http://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()))
                                                            68. Patient.identifier:cpf.system
                                                            Definition

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

                                                            ShortO identificador do sistema de identificação
                                                            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.

                                                            Pattern Valuehttps://fhir.saude.go.gov.br/sid/cpf
                                                            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()))
                                                            70. Patient.identifier:cpf.value
                                                            Definition

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

                                                            ShortNúmero do Cadastro de Pessoas Físicas do indivíduo
                                                            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()))
                                                            72. Patient.identifier:cpf.period
                                                            Definition

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

                                                            ShortTime period when id is/was valid for use
                                                            Control0..0
                                                            TypePeriod
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            74. Patient.identifier:cpf.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..0
                                                            TypeReference(Organization)
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            76. Patient.identifier:cns
                                                            Slice Namecns
                                                            Definition

                                                            An identifier for this patient.

                                                            ShortIdentificação pelo Cartão Nacional de Saúde
                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                            Control1..1
                                                            TypeIdentifier
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Requirements

                                                            Patients are almost always assigned specific numerical identifiers.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            78. Patient.identifier:cns.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
                                                            80. Patient.identifier:cns.extension
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..0
                                                            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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 82. Patient.identifier:cns.use
                                                              Definition

                                                              The purpose of this identifier.

                                                              Shortusual | official | temp | secondary | old (If known)
                                                              Comments

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

                                                              Control0..0
                                                              BindingThe codes SHALL be taken from IdentifierUse
                                                              (required to http://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()))
                                                              84. Patient.identifier:cns.type
                                                              Definition

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

                                                              ShortDescription 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..0
                                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                              (extensible to http://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()))
                                                              86. Patient.identifier:cns.system
                                                              Definition

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

                                                              ShortO identificador do sistema de identificação
                                                              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.

                                                              Pattern Valuehttps://fhir.saude.go.gov.br/sid/cns
                                                              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()))
                                                              88. Patient.identifier:cns.value
                                                              Definition

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

                                                              ShortNúmero do Cartão Nacional de Saúde do indivíduo
                                                              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()))
                                                              90. Patient.identifier:cns.period
                                                              Definition

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

                                                              ShortTime period when id is/was valid for use
                                                              Control0..0
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              92. Patient.identifier:cns.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..0
                                                              TypeReference(Organization)
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              94. Patient.active
                                                              Definition

                                                              Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                              It is often used to filter patient lists to exclude inactive patients

                                                              Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                              ShortWhether this patient's record is in active use
                                                              Comments

                                                              If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                                              Control0..0
                                                              Typeboolean
                                                              Is Modifiertrue because 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
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to mark a patient record as not to be used because it was created in error.

                                                              Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              96. Patient.name
                                                              Definition

                                                              A name associated with the individual.

                                                              ShortNome(s) utilizado(s) pelo indivíduo
                                                              Comments

                                                              A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                              Control1..2
                                                              TypeHumanName(Nome do cidadão)
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                              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 Patient.name. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                              • pattern @ use
                                                              • 98. Patient.name:official
                                                                Slice Nameofficial
                                                                Definition

                                                                A name associated with the individual.

                                                                ShortNome oficial do indivíduo
                                                                Comments

                                                                A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                Control1..1
                                                                TypeHumanName(Nome do cidadão)
                                                                Is Modifierfalse
                                                                Summarytrue
                                                                Requirements

                                                                Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                100. Patient.name:official.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
                                                                102. Patient.name:official.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..0
                                                                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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 104. Patient.name:official.use
                                                                  Definition

                                                                  Identifies the purpose for this name.

                                                                  ShortCódigo que identifica o tipo de nome informado
                                                                  Comments

                                                                  Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                  Control1..1
                                                                  BindingThe codes SHALL be taken from Tipo de uso do nome do cidadão
                                                                  (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
                                                                  Typecode
                                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

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

                                                                  Pattern Valueofficial
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  106. Patient.name:official.text
                                                                  Definition

                                                                  Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                  ShortRepresentação de texto do nome completo do indivíduo
                                                                  Comments

                                                                  Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                                                                  A renderable, unencoded form.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  108. Patient.name:official.family
                                                                  Definition

                                                                  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                  ShortFamily name (often called 'Surname')
                                                                  Comments

                                                                  Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                  Control0..0
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Alternate Namessurname
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  110. Patient.name:official.given
                                                                  Definition

                                                                  Given name.

                                                                  ShortGiven names (not always 'first'). Includes middle names
                                                                  Comments

                                                                  If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                  Control0..0
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Alternate Namesfirst name, middle name
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  112. Patient.name:official.prefix
                                                                  Definition

                                                                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                  ShortParts that come before the name
                                                                  Control0..0
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  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()))
                                                                  114. Patient.name:official.suffix
                                                                  Definition

                                                                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                  ShortParts that come after the name
                                                                  Control0..0
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  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()))
                                                                  116. Patient.name:official.period
                                                                  Definition

                                                                  Indicates the period of time when this name was valid for the named person.

                                                                  ShortTime period when name was/is in use
                                                                  Control0..0
                                                                  TypePeriod
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Requirements

                                                                  Allows names to be placed in historical context.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  118. Patient.name:usual
                                                                  Slice Nameusual
                                                                  Definition

                                                                  A name associated with the individual.

                                                                  ShortNome social do indivíduo
                                                                  Comments

                                                                  A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                  Control0..1
                                                                  TypeHumanName(Nome do cidadão)
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  120. Patient.name:usual.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
                                                                  122. Patient.name:usual.extension
                                                                  Definition

                                                                  An Extension

                                                                  ShortExtension
                                                                  Control0..0
                                                                  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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 124. Patient.name:usual.use
                                                                    Definition

                                                                    Identifies the purpose for this name.

                                                                    ShortCódigo que identifica o tipo de nome informado
                                                                    Comments

                                                                    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                    Control1..1
                                                                    BindingThe codes SHALL be taken from Tipo de uso do nome do cidadão
                                                                    (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
                                                                    Typecode
                                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Requirements

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

                                                                    Pattern Valueusual
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    126. Patient.name:usual.text
                                                                    Definition

                                                                    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                    ShortRepresentação de texto do nome completo do indivíduo
                                                                    Comments

                                                                    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                                                                    A renderable, unencoded form.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    128. Patient.name:usual.family
                                                                    Definition

                                                                    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                    ShortFamily name (often called 'Surname')
                                                                    Comments

                                                                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                    Control0..0
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Alternate Namessurname
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    130. Patient.name:usual.given
                                                                    Definition

                                                                    Given name.

                                                                    ShortGiven names (not always 'first'). Includes middle names
                                                                    Comments

                                                                    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                    Control0..0
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Alternate Namesfirst name, middle name
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    132. Patient.name:usual.prefix
                                                                    Definition

                                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                    ShortParts that come before the name
                                                                    Control0..0
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    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()))
                                                                    134. Patient.name:usual.suffix
                                                                    Definition

                                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                    ShortParts that come after the name
                                                                    Control0..0
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    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()))
                                                                    136. Patient.name:usual.period
                                                                    Definition

                                                                    Indicates the period of time when this name was valid for the named person.

                                                                    ShortTime period when name was/is in use
                                                                    Control0..0
                                                                    TypePeriod
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    Allows names to be placed in historical context.

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

                                                                    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                    ShortMeio(s) para entrar em contato com o indivíduo
                                                                    Comments

                                                                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                    Control1..*
                                                                    TypeContactPoint
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    People have (primary) ways to contact them in some way such as phone, email.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    NumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                                                                    EmailValido: Máscara de email xxx@xxx.xx ($this.where(system = 'email').select(value).all(matches('^([\\w-\\.]+){1,64}@([\\w&&[^_]]+){2,255}(.[a-z]{2,}){1,}$')))
                                                                    SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                    • pattern @ system
                                                                    • 140. Patient.telecom:phone
                                                                      Slice Namephone
                                                                      Definition

                                                                      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                      ShortTelefone do indivíduo
                                                                      Comments

                                                                      A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                      Control0..*
                                                                      TypeContactPoint
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      People have (primary) ways to contact them in some way such as phone, email.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      142. Patient.telecom:phone.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
                                                                      144. Patient.telecom:phone.extension
                                                                      Definition

                                                                      An Extension

                                                                      ShortExtension
                                                                      Control0..0
                                                                      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 Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 146. Patient.telecom:phone.system
                                                                        Definition

                                                                        Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                        ShortSistema de códigos que define o tipo de meio de contato
                                                                        Control1..1
                                                                        This element is affected by the following invariants: cpt-2
                                                                        BindingThe codes SHALL be taken from ContactPointSystem
                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                        Sistema de comunicação

                                                                        Typecode
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Pattern Valuephone
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        148. Patient.telecom:phone.value
                                                                        Definition

                                                                        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                        ShortValor do meio de contato
                                                                        Comments

                                                                        Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                                                                        Need to support legacy numbers that are not in a tightly controlled format.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        150. Patient.telecom:phone.use
                                                                        Definition

                                                                        Identifies the purpose for the contact point.

                                                                        Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                        Comments

                                                                        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                        Control0..0
                                                                        BindingThe codes SHALL be taken from ContactPointUse
                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                        Use of contact point.

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

                                                                        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        152. Patient.telecom:phone.rank
                                                                        Definition

                                                                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                        ShortSpecify preferred order of use (1 = highest)
                                                                        Comments

                                                                        Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                        Control0..0
                                                                        TypepositiveInt
                                                                        Is Modifierfalse
                                                                        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()))
                                                                        154. Patient.telecom:phone.period
                                                                        Definition

                                                                        Time period when the contact point was/is in use.

                                                                        ShortTime period when the contact point was/is in use
                                                                        Control0..0
                                                                        TypePeriod
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        156. Patient.telecom:email
                                                                        Slice Nameemail
                                                                        Definition

                                                                        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                        ShortEmail do indivíduo
                                                                        Comments

                                                                        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                        Control0..*
                                                                        TypeContactPoint
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Requirements

                                                                        People have (primary) ways to contact them in some way such as phone, email.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        158. Patient.telecom:email.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
                                                                        160. Patient.telecom:email.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..0
                                                                        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 Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 162. Patient.telecom:email.system
                                                                          Definition

                                                                          Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                          ShortSistema de códigos que define o tipo de meio de contato
                                                                          Control1..1
                                                                          This element is affected by the following invariants: cpt-2
                                                                          BindingThe codes SHALL be taken from ContactPointSystem
                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                          Sistema de comunicação

                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Pattern Valueemail
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          164. Patient.telecom:email.value
                                                                          Definition

                                                                          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                          ShortValor do meio de contato
                                                                          Comments

                                                                          Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                                                                          Need to support legacy numbers that are not in a tightly controlled format.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          166. Patient.telecom:email.use
                                                                          Definition

                                                                          Identifies the purpose for the contact point.

                                                                          Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                          Comments

                                                                          Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                          Control0..0
                                                                          BindingThe codes SHALL be taken from ContactPointUse
                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                          Use of contact point.

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

                                                                          Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          168. Patient.telecom:email.rank
                                                                          Definition

                                                                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                          ShortSpecify preferred order of use (1 = highest)
                                                                          Comments

                                                                          Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                          Control0..0
                                                                          TypepositiveInt
                                                                          Is Modifierfalse
                                                                          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()))
                                                                          170. Patient.telecom:email.period
                                                                          Definition

                                                                          Time period when the contact point was/is in use.

                                                                          ShortTime period when the contact point was/is in use
                                                                          Control0..0
                                                                          TypePeriod
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          172. Patient.gender
                                                                          Definition

                                                                          Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                                                                          Shortmale | female | other | unknown
                                                                          Comments

                                                                          The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                                          Control1..1
                                                                          BindingThe codes SHALL be taken from AdministrativeGender
                                                                          (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                          Código que identifica o sexo do indivíduo, conforme documento oficial

                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Requirements

                                                                          Needed for identification of the individual, in combination with (at least) name and birth date.

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

                                                                          The date of birth for the individual.

                                                                          ShortData em que o indivíduo nasceu, conforme documento oficial
                                                                          Comments

                                                                          At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

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

                                                                          Age of the individual drives many clinical processes.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          DataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
                                                                          LOINC Code21112-8
                                                                          176. Patient.deceased[x]
                                                                          Definition

                                                                          Indicates if the individual is deceased or not.

                                                                          ShortIndicates if the individual is deceased or not
                                                                          Comments

                                                                          If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                          Control0..0
                                                                          TypeChoice of: boolean, dateTime
                                                                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Requirements

                                                                          The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

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

                                                                          An address for the individual.

                                                                          ShortEndereço de residência do indivíduo
                                                                          Comments

                                                                          Patient may have multiple addresses with different uses or applicable periods.

                                                                          Control1..1
                                                                          TypeAddress
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          180. Patient.address.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..0
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          182. Patient.address.extension
                                                                          Definition

                                                                          An Extension

                                                                          ShortExtension
                                                                          Control0..0
                                                                          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 Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 184. Patient.address.use
                                                                            Definition

                                                                            The purpose of this address.

                                                                            ShortCódigo que identifica o tipo de endereço informado
                                                                            Comments

                                                                            Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                            Control1..1
                                                                            BindingThe codes SHALL be taken from AddressUse
                                                                            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                            The use of an address.

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

                                                                            Allows an appropriate address to be chosen from a list of many.

                                                                            Pattern Valuehome
                                                                            Example<br/><b>General</b>:home
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            186. Patient.address.type
                                                                            Definition

                                                                            Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                                            Shortpostal | physical | both
                                                                            Comments

                                                                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                            Control0..0
                                                                            BindingThe codes SHALL be taken from AddressType
                                                                            (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                            The type of an address (physical / postal).

                                                                            Typecode
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Example<br/><b>General</b>:both
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            188. Patient.address.text
                                                                            Definition

                                                                            Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                            ShortText representation of the address
                                                                            Comments

                                                                            Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                                                                            A renderable, unencoded form.

                                                                            Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            190. Patient.address.line
                                                                            Definition

                                                                            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                            ShortElementos necessários ao endereçamento brasileiro
                                                                            Control0..5
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Example<br/><b>General</b>:137 Nowhere Street
                                                                            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 Patient.address.line. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                            • value @ extension.value
                                                                            • 192. Patient.address.line.id
                                                                              Definition

                                                                              unique id for the element within a resource (for internal references)

                                                                              Shortxml:id (or equivalent in JSON)
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              194. Patient.address.line.extension
                                                                              Definition

                                                                              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.

                                                                              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())
                                                                              196. Patient.address.line.extension.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
                                                                              198. Patient.address.line.extension.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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 200. Patient.address.line.extension.url
                                                                                Definition

                                                                                Source of the definition for the extension code - a logical name or a URL.

                                                                                Shortidentifies the meaning of the extension
                                                                                Comments

                                                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                Control1..1
                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Pattern Valuehttps://fhir.saude.go.gov.br/r4/core/StructureDefinition/tipo-informacao-endereco
                                                                                202. Patient.address.line.extension.value[x]
                                                                                Definition

                                                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                ShortValue of extension
                                                                                Control0..1
                                                                                TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                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()))
                                                                                204. Patient.address.line.value
                                                                                Definition

                                                                                The actual value

                                                                                ShortPrimitive value for string
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Max Length:1048576
                                                                                206. Patient.address.line:bairro
                                                                                Slice Namebairro
                                                                                Definition

                                                                                This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                ShortBairro da residência do indivíduo
                                                                                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>:137 Nowhere Street
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                208. Patient.address.line:bairro.id
                                                                                Definition

                                                                                unique id for the element within a resource (for internal references)

                                                                                Shortxml:id (or equivalent in JSON)
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                210. Patient.address.line:bairro.extension
                                                                                Definition

                                                                                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.

                                                                                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())
                                                                                212. Patient.address.line:bairro.extension.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
                                                                                214. Patient.address.line:bairro.extension.extension
                                                                                Definition

                                                                                An Extension

                                                                                ShortExtension
                                                                                Control0..0
                                                                                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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 216. Patient.address.line:bairro.extension.url
                                                                                  Definition

                                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                                  Shortidentifies the meaning of the extension
                                                                                  Comments

                                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                  Control1..1
                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  218. Patient.address.line:bairro.extension.value[x]
                                                                                  Definition

                                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                  ShortValue of extension
                                                                                  Control0..1
                                                                                  Typecode
                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                  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()))
                                                                                  SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                  • type @ $this
                                                                                  • 220. Patient.address.line:bairro.extension.value[x]:valueCode
                                                                                    Slice NamevalueCode
                                                                                    Definition

                                                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                    ShortValue of extension
                                                                                    Control0..1
                                                                                    Typecode
                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summaryfalse
                                                                                    Pattern Valuebairro
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    222. Patient.address.line:bairro.value
                                                                                    Definition

                                                                                    The actual value

                                                                                    ShortPrimitive value for string
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    Max Length:1048576
                                                                                    224. Patient.address.line:logradouro
                                                                                    Slice Namelogradouro
                                                                                    Definition

                                                                                    This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                    ShortNome do logradouro da residência do indivíduo
                                                                                    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>:137 Nowhere Street
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    226. Patient.address.line:logradouro.id
                                                                                    Definition

                                                                                    unique id for the element within a resource (for internal references)

                                                                                    Shortxml:id (or equivalent in JSON)
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    228. Patient.address.line:logradouro.extension
                                                                                    Definition

                                                                                    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.

                                                                                    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())
                                                                                    230. Patient.address.line:logradouro.extension.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
                                                                                    232. Patient.address.line:logradouro.extension.extension
                                                                                    Definition

                                                                                    An Extension

                                                                                    ShortExtension
                                                                                    Control0..0
                                                                                    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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 234. Patient.address.line:logradouro.extension.url
                                                                                      Definition

                                                                                      Source of the definition for the extension code - a logical name or a URL.

                                                                                      Shortidentifies the meaning of the extension
                                                                                      Comments

                                                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                      Control1..1
                                                                                      Typeuri
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      236. Patient.address.line:logradouro.extension.value[x]
                                                                                      Definition

                                                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                      ShortValue of extension
                                                                                      Control0..1
                                                                                      Typecode
                                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                      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()))
                                                                                      SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                      • type @ $this
                                                                                      • 238. Patient.address.line:logradouro.extension.value[x]:valueCode
                                                                                        Slice NamevalueCode
                                                                                        Definition

                                                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                        ShortValue of extension
                                                                                        Control0..1
                                                                                        Typecode
                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summaryfalse
                                                                                        Pattern Valuelogradouro
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        240. Patient.address.line:logradouro.value
                                                                                        Definition

                                                                                        The actual value

                                                                                        ShortPrimitive value for string
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        Max Length:1048576
                                                                                        242. Patient.address.line:numero
                                                                                        Slice Namenumero
                                                                                        Definition

                                                                                        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                        ShortNúmero da residência do indivíduo
                                                                                        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>:137 Nowhere Street
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        244. Patient.address.line:numero.id
                                                                                        Definition

                                                                                        unique id for the element within a resource (for internal references)

                                                                                        Shortxml:id (or equivalent in JSON)
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        246. Patient.address.line:numero.extension
                                                                                        Definition

                                                                                        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.

                                                                                        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())
                                                                                        248. Patient.address.line:numero.extension.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
                                                                                        250. Patient.address.line:numero.extension.extension
                                                                                        Definition

                                                                                        An Extension

                                                                                        ShortExtension
                                                                                        Control0..0
                                                                                        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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 252. Patient.address.line:numero.extension.url
                                                                                          Definition

                                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                                          Shortidentifies the meaning of the extension
                                                                                          Comments

                                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                          Control1..1
                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          254. Patient.address.line:numero.extension.value[x]
                                                                                          Definition

                                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                          ShortValue of extension
                                                                                          Control0..1
                                                                                          Typecode
                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                          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()))
                                                                                          SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                          • type @ $this
                                                                                          • 256. Patient.address.line:numero.extension.value[x]:valueCode
                                                                                            Slice NamevalueCode
                                                                                            Definition

                                                                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                            ShortValue of extension
                                                                                            Control0..1
                                                                                            Typecode
                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summaryfalse
                                                                                            Pattern Valuenumero
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            258. Patient.address.line:numero.value
                                                                                            Definition

                                                                                            The actual value

                                                                                            ShortPrimitive value for string
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            Max Length:1048576
                                                                                            260. Patient.address.line:complemento
                                                                                            Slice Namecomplemento
                                                                                            Definition

                                                                                            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                            ShortComplemento do endereço da residência do indivíduo
                                                                                            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>:137 Nowhere Street
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            262. Patient.address.line:complemento.id
                                                                                            Definition

                                                                                            unique id for the element within a resource (for internal references)

                                                                                            Shortxml:id (or equivalent in JSON)
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            264. Patient.address.line:complemento.extension
                                                                                            Definition

                                                                                            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.

                                                                                            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())
                                                                                            266. Patient.address.line:complemento.extension.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
                                                                                            268. Patient.address.line:complemento.extension.extension
                                                                                            Definition

                                                                                            An Extension

                                                                                            ShortExtension
                                                                                            Control0..0
                                                                                            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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 270. Patient.address.line:complemento.extension.url
                                                                                              Definition

                                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                                              Shortidentifies the meaning of the extension
                                                                                              Comments

                                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                              Control1..1
                                                                                              Typeuri
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              272. Patient.address.line:complemento.extension.value[x]
                                                                                              Definition

                                                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                              ShortValue of extension
                                                                                              Control0..1
                                                                                              Typecode
                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                              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()))
                                                                                              SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                              • type @ $this
                                                                                              • 274. Patient.address.line:complemento.extension.value[x]:valueCode
                                                                                                Slice NamevalueCode
                                                                                                Definition

                                                                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                ShortValue of extension
                                                                                                Control0..1
                                                                                                Typecode
                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Summaryfalse
                                                                                                Pattern Valuecomplemento
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                276. Patient.address.line:complemento.value
                                                                                                Definition

                                                                                                The actual value

                                                                                                ShortPrimitive value for string
                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                Max Length:1048576
                                                                                                278. Patient.address.line:tipologradouro
                                                                                                Slice Nametipologradouro
                                                                                                Definition

                                                                                                This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                                ShortTipo de logradouro da residência do indivíduo
                                                                                                Control0..1
                                                                                                BindingThe codes SHALL be taken from Tipo de Logradouro
                                                                                                (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/tipo-logradouro)
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Summarytrue
                                                                                                Example<br/><b>General</b>:137 Nowhere Street
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                280. Patient.address.line:tipologradouro.id
                                                                                                Definition

                                                                                                unique id for the element within a resource (for internal references)

                                                                                                Shortxml:id (or equivalent in JSON)
                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                282. Patient.address.line:tipologradouro.extension
                                                                                                Definition

                                                                                                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.

                                                                                                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())
                                                                                                284. Patient.address.line:tipologradouro.extension.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
                                                                                                286. Patient.address.line:tipologradouro.extension.extension
                                                                                                Definition

                                                                                                An Extension

                                                                                                ShortExtension
                                                                                                Control0..0
                                                                                                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 Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                • value @ url
                                                                                                • 288. Patient.address.line:tipologradouro.extension.url
                                                                                                  Definition

                                                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                                                  Shortidentifies the meaning of the extension
                                                                                                  Comments

                                                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                  Control1..1
                                                                                                  Typeuri
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  290. Patient.address.line:tipologradouro.extension.value[x]
                                                                                                  Definition

                                                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                  ShortValue of extension
                                                                                                  Control0..1
                                                                                                  Typecode
                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                  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()))
                                                                                                  SlicingThis element introduces a set of slices on Patient.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                  • type @ $this
                                                                                                  • 292. Patient.address.line:tipologradouro.extension.value[x]:valueCode
                                                                                                    Slice NamevalueCode
                                                                                                    Definition

                                                                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                    ShortValue of extension
                                                                                                    Control0..1
                                                                                                    Typecode
                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summaryfalse
                                                                                                    Pattern Valuetipologradouro
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    294. Patient.address.line:tipologradouro.value
                                                                                                    Definition

                                                                                                    The actual value

                                                                                                    ShortPrimitive value for string
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    Max Length:1048576
                                                                                                    296. Patient.address.city
                                                                                                    Definition

                                                                                                    The name of the city, town, suburb, village or other community or delivery center.

                                                                                                    ShortMunicípio de residência do indivíduo
                                                                                                    Control1..1
                                                                                                    BindingThe codes SHALL be taken from Município
                                                                                                    (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Alternate NamesMunicpality
                                                                                                    Example<br/><b>General</b>:Erewhon
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    298. Patient.address.district
                                                                                                    Definition

                                                                                                    The name of the administrative area (county).

                                                                                                    ShortDistrict name (aka county)
                                                                                                    Comments

                                                                                                    District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                                                    Control0..0
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Alternate NamesCounty
                                                                                                    Example<br/><b>General</b>:Madison
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    300. Patient.address.state
                                                                                                    Definition

                                                                                                    Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                                                    ShortSub-unit of country (abbreviations ok)
                                                                                                    Control0..0
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Alternate NamesProvince, Territory
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    302. Patient.address.postalCode
                                                                                                    Definition

                                                                                                    A postal code designating a region defined by the postal service.

                                                                                                    ShortCódigo de Endereçamento Postal da residência do indivíduo
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Alternate NamesZip
                                                                                                    Example<br/><b>General</b>:9132
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    304. Patient.address.country
                                                                                                    Definition

                                                                                                    Country - a nation as commonly understood or generally accepted.

                                                                                                    ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                                                                    Comments

                                                                                                    ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                                    Control0..0
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    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()))
                                                                                                    306. Patient.address.period
                                                                                                    Definition

                                                                                                    Time period when address was/is in use.

                                                                                                    ShortTime period when address was/is in use
                                                                                                    Control0..0
                                                                                                    TypePeriod
                                                                                                    Is Modifierfalse
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Allows addresses to be placed in historical context.

                                                                                                    Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    308. Patient.maritalStatus
                                                                                                    Definition

                                                                                                    This field contains a patient's most recent marital (civil) status.

                                                                                                    ShortEstado civil do indivíduo
                                                                                                    Control0..1
                                                                                                    BindingThe codes SHALL be taken from Estado Civil
                                                                                                    (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/estado-civil)
                                                                                                    TypeCodeableConcept
                                                                                                    Is Modifierfalse
                                                                                                    Summaryfalse
                                                                                                    Requirements

                                                                                                    Most, if not all systems capture it.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    310. Patient.maritalStatus.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
                                                                                                    312. Patient.maritalStatus.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 Patient.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                    • value @ url
                                                                                                    • 314. Patient.maritalStatus.coding
                                                                                                      Definition

                                                                                                      A reference to a code defined by a terminology system.

                                                                                                      ShortCodificação que representa o estado civil de um indivíduo
                                                                                                      Comments

                                                                                                      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.

                                                                                                      Control0..*
                                                                                                      TypeCoding
                                                                                                      Is Modifierfalse
                                                                                                      Summarytrue
                                                                                                      Requirements

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

                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      316. Patient.maritalStatus.coding.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
                                                                                                      318. Patient.maritalStatus.coding.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 Patient.maritalStatus.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                      • value @ url
                                                                                                      • 320. Patient.maritalStatus.coding.system
                                                                                                        Definition

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

                                                                                                        ShortSistema de códigos que define o estado civil de um indivíduo
                                                                                                        Comments

                                                                                                        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.

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

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

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        322. Patient.maritalStatus.coding.version
                                                                                                        Definition

                                                                                                        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.

                                                                                                        ShortVersion of the system - if relevant
                                                                                                        Comments

                                                                                                        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.

                                                                                                        NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                        Control0..1
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        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()))
                                                                                                        324. Patient.maritalStatus.coding.code
                                                                                                        Definition

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

                                                                                                        ShortCódigo que identifica o estado civil do indivíduo
                                                                                                        Control0..1
                                                                                                        Typecode
                                                                                                        Is Modifierfalse
                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                        Summarytrue
                                                                                                        Requirements

                                                                                                        Need to refer to a particular code in the system.

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        326. Patient.maritalStatus.coding.display
                                                                                                        Definition

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

                                                                                                        ShortRepresentation defined by the system
                                                                                                        Control0..1
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                        Summarytrue
                                                                                                        Requirements

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

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        328. Patient.maritalStatus.coding.userSelected
                                                                                                        Definition

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

                                                                                                        ShortIf this coding was chosen directly by the user
                                                                                                        Comments

                                                                                                        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.

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

                                                                                                        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.

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

                                                                                                        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.

                                                                                                        ShortPlain text representation of the concept
                                                                                                        Comments

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

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

                                                                                                        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.

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        332. Patient.multipleBirth[x]
                                                                                                        Definition

                                                                                                        Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                                        ShortWhether patient is part of a multiple birth
                                                                                                        Comments

                                                                                                        Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                                        Control0..0
                                                                                                        TypeChoice of: boolean, integer
                                                                                                        Is Modifierfalse
                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                        Summaryfalse
                                                                                                        Requirements

                                                                                                        For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

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

                                                                                                        Image of the patient.

                                                                                                        ShortFotografia do indivíduo
                                                                                                        Comments

                                                                                                        Guidelines:

                                                                                                        • Use id photos, not clinical photos.
                                                                                                        • Limit dimensions to thumbnail.
                                                                                                        • Keep byte count low to ease resource updates.
                                                                                                        Control0..1
                                                                                                        TypeAttachment
                                                                                                        Is Modifierfalse
                                                                                                        Summaryfalse
                                                                                                        Requirements

                                                                                                        Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        336. Patient.photo.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
                                                                                                        338. Patient.photo.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 Patient.photo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                        • value @ url
                                                                                                        • 340. Patient.photo.contentType
                                                                                                          Definition

                                                                                                          Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                                                                                          ShortMime type of the content, with charset etc.
                                                                                                          Control1..1
                                                                                                          BindingThe codes SHALL be taken from Mime Types
                                                                                                          (required to http://hl7.org/fhir/ValueSet/mimetypes)
                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Processors of the data need to be able to know how to interpret the data.

                                                                                                          Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          342. Patient.photo.language
                                                                                                          Definition

                                                                                                          The human language of the content. The value can be any valid value according to BCP 47.

                                                                                                          ShortHuman language of the content (BCP-47)
                                                                                                          Control0..0
                                                                                                          BindingThe codes SHOULD be taken from CommonLanguages
                                                                                                          (preferred to http://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
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Users need to be able to choose between the languages in a set of attachments.

                                                                                                          Example<br/><b>General</b>:en-AU
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          344. Patient.photo.data
                                                                                                          Definition

                                                                                                          The actual data of the attachment - a sequence of bytes, base64 encoded.

                                                                                                          ShortData inline, base64ed
                                                                                                          Comments

                                                                                                          The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

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

                                                                                                          The data needs to able to be transmitted inline.

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

                                                                                                          A location where the data can be accessed.

                                                                                                          ShortUri where the data can be found
                                                                                                          Comments

                                                                                                          If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                                                                                                          The data needs to be transmitted by reference.

                                                                                                          Example<br/><b>General</b>:http://www.acme.com/logo-small.png
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          348. Patient.photo.size
                                                                                                          Definition

                                                                                                          The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                                                                                          ShortNumber of bytes of content (if url provided)
                                                                                                          Comments

                                                                                                          The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                                                                                                          Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

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

                                                                                                          The calculated hash of the data using SHA-1. Represented using base64.

                                                                                                          ShortHash of the data (sha-1, base64ed)
                                                                                                          Comments

                                                                                                          The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                                                                                                          Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

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

                                                                                                          A label or set of text to display in place of the data.

                                                                                                          ShortLabel to display in place of the data
                                                                                                          Control0..0
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                                                                                          Example<br/><b>General</b>:Official Corporate Logo
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          354. Patient.photo.creation
                                                                                                          Definition

                                                                                                          The date that the attachment was first created.

                                                                                                          ShortDate attachment was first created
                                                                                                          Control0..0
                                                                                                          TypedateTime
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          This is often tracked as an integrity issue for use of the attachment.

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

                                                                                                          A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                                          ShortPessoa(s) de referência do indivíduo a ser(em) contactada(s) em caso de necessidade
                                                                                                          Comments

                                                                                                          Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                                          Control0..*
                                                                                                          TypeBackboneElement
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Requirements

                                                                                                          Need to track people you can contact about the patient.

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                                          358. Patient.contact.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
                                                                                                          360. Patient.contact.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())
                                                                                                          362. Patient.contact.modifierExtension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          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 element that contains them
                                                                                                          Summarytrue
                                                                                                          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, modifiers
                                                                                                          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())
                                                                                                          364. Patient.contact.relationship
                                                                                                          Definition

                                                                                                          The nature of the relationship between the patient and the contact person.

                                                                                                          ShortTipo de relacionamento do indivíduo com a pessoa de referência
                                                                                                          Control1..1
                                                                                                          BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                                          (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                                          The nature of the relationship between a patient and a contact person for that patient.

                                                                                                          TypeCodeableConcept
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Requirements

                                                                                                          Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          366. Patient.contact.relationship.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
                                                                                                          368. Patient.contact.relationship.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 Patient.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                          • value @ url
                                                                                                          • 370. Patient.contact.relationship.coding
                                                                                                            Definition

                                                                                                            A reference to a code defined by a terminology system.

                                                                                                            ShortCodificação que representa o tipo de relacionamento do indivíduo com a pessoa de referência
                                                                                                            Comments

                                                                                                            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.

                                                                                                            Control1..1
                                                                                                            BindingThe codes SHALL be taken from RelacaoContato
                                                                                                            (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/relacao-contato)
                                                                                                            TypeCoding
                                                                                                            Is Modifierfalse
                                                                                                            Summarytrue
                                                                                                            Requirements

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

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            372. Patient.contact.relationship.coding.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
                                                                                                            374. Patient.contact.relationship.coding.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 Patient.contact.relationship.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                            • value @ url
                                                                                                            • 376. Patient.contact.relationship.coding.system
                                                                                                              Definition

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

                                                                                                              ShortSistema de códigos que define o tipo de relacionamento do indivíduo com a pessoa de referência
                                                                                                              Comments

                                                                                                              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.

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

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

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              378. Patient.contact.relationship.coding.version
                                                                                                              Definition

                                                                                                              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.

                                                                                                              ShortVersion of the system - if relevant
                                                                                                              Comments

                                                                                                              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.

                                                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                              Control0..1
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              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()))
                                                                                                              380. Patient.contact.relationship.coding.code
                                                                                                              Definition

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

                                                                                                              ShortCódigo que identifica o tipo de relacionamento do indivíduo com a pessoa de referência
                                                                                                              Control0..1
                                                                                                              Typecode
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              Need to refer to a particular code in the system.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              382. Patient.contact.relationship.coding.display
                                                                                                              Definition

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

                                                                                                              ShortRepresentation defined by the system
                                                                                                              Control0..1
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Requirements

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

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              384. Patient.contact.relationship.coding.userSelected
                                                                                                              Definition

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

                                                                                                              ShortIf this coding was chosen directly by the user
                                                                                                              Comments

                                                                                                              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.

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

                                                                                                              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.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              386. Patient.contact.relationship.text
                                                                                                              Definition

                                                                                                              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.

                                                                                                              ShortPlain text representation of the concept
                                                                                                              Comments

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

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

                                                                                                              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.

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

                                                                                                              A name associated with the contact person.

                                                                                                              ShortNome utilizado pela pessoa de referência
                                                                                                              Control1..1
                                                                                                              TypeHumanName
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Requirements

                                                                                                              Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              390. Patient.contact.name.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
                                                                                                              392. Patient.contact.name.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 Patient.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                              • value @ url
                                                                                                              • 394. Patient.contact.name.use
                                                                                                                Definition

                                                                                                                Identifies the purpose for this name.

                                                                                                                Shortusual | official | temp | nickname | anonymous | old | maiden
                                                                                                                Comments

                                                                                                                Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                                                                Control0..0
                                                                                                                BindingThe codes SHALL be taken from NameUse
                                                                                                                (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                                                                The use of a human name.

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

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

                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                396. Patient.contact.name.text
                                                                                                                Definition

                                                                                                                Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                                                                ShortRepresentação de texto do nome completo da pessoa de referêcia
                                                                                                                Comments

                                                                                                                Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

                                                                                                                A renderable, unencoded form.

                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                398. Patient.contact.name.family
                                                                                                                Definition

                                                                                                                The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                                                ShortFamily name (often called 'Surname')
                                                                                                                Comments

                                                                                                                Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                                                                Control0..0
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Summarytrue
                                                                                                                Alternate Namessurname
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                400. Patient.contact.name.given
                                                                                                                Definition

                                                                                                                Given name.

                                                                                                                ShortGiven names (not always 'first'). Includes middle names
                                                                                                                Comments

                                                                                                                If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                                                                Control0..0
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Summarytrue
                                                                                                                Alternate Namesfirst name, middle name
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                402. Patient.contact.name.prefix
                                                                                                                Definition

                                                                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                                                ShortParts that come before the name
                                                                                                                Control0..0
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                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()))
                                                                                                                404. Patient.contact.name.suffix
                                                                                                                Definition

                                                                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                                                ShortParts that come after the name
                                                                                                                Control0..0
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                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()))
                                                                                                                406. Patient.contact.name.period
                                                                                                                Definition

                                                                                                                Indicates the period of time when this name was valid for the named person.

                                                                                                                ShortTime period when name was/is in use
                                                                                                                Control0..0
                                                                                                                TypePeriod
                                                                                                                Is Modifierfalse
                                                                                                                Summarytrue
                                                                                                                Requirements

                                                                                                                Allows names to be placed in historical context.

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

                                                                                                                A contact detail for the person, e.g. a telephone number or an email address.

                                                                                                                ShortMeio(s) para entrar em contato com a pessoa de referência
                                                                                                                Comments

                                                                                                                Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                                                Control0..1
                                                                                                                TypeContactPoint
                                                                                                                Is Modifierfalse
                                                                                                                Summaryfalse
                                                                                                                Requirements

                                                                                                                People have (primary) ways to contact them in some way such as phone, email.

                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                NumeroTelefoneValido: Máscara de telefone para números nacionais (xx) xxxx-xxxx ou (xx) xxxxx-xxxx. Para números internacionais, o + significa que será utilizado o código do país, a lógica é de 1 a 3 dígitos de código do país (+X, +XX ou +XXX), na sequência uma quantidade de dígitos entre o código de área e o número propriamente dito que, somados ao código do país, não podem exceder 15 dígitos. ($this.where(system = 'phone').select(value).all(matches('^((\\(([0-9]{2})\\)) ([0-9]{4,5})\\-([0-9]{4}))|^((\\+\\d{1,3}) (\\d{2,3})) \\d{3,5}\\-\\d{4}$')))
                                                                                                                410. Patient.contact.telecom.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
                                                                                                                412. Patient.contact.telecom.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 Patient.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                • value @ url
                                                                                                                • 414. Patient.contact.telecom.system
                                                                                                                  Definition

                                                                                                                  Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                                                                  ShortCódigo que identifica o tipo de meio de contato utilizado para entrar em contato com a pessoa de referência
                                                                                                                  Control1..1
                                                                                                                  This element is affected by the following invariants: cpt-2
                                                                                                                  BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                                  Telecommunications form for contact point.

                                                                                                                  Typecode
                                                                                                                  Is Modifierfalse
                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                  Summarytrue
                                                                                                                  Pattern Valuephone
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  416. Patient.contact.telecom.value
                                                                                                                  Definition

                                                                                                                  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                                                                  ShortValor do meio de contato da pessoa de referência
                                                                                                                  Comments

                                                                                                                  Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                                                                                                                  Need to support legacy numbers that are not in a tightly controlled format.

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  418. Patient.contact.telecom.use
                                                                                                                  Definition

                                                                                                                  Identifies the purpose for the contact point.

                                                                                                                  Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                                                                  Comments

                                                                                                                  Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                                                                  Control0..1
                                                                                                                  BindingThe codes SHALL be taken from ContactPointUse
                                                                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                                                                  Use of contact point.

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

                                                                                                                  Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  420. Patient.contact.telecom.rank
                                                                                                                  Definition

                                                                                                                  Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                                  ShortSpecify preferred order of use (1 = highest)
                                                                                                                  Comments

                                                                                                                  Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                                                                  Control0..1
                                                                                                                  TypepositiveInt
                                                                                                                  Is Modifierfalse
                                                                                                                  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()))
                                                                                                                  422. Patient.contact.telecom.period
                                                                                                                  Definition

                                                                                                                  Time period when the contact point was/is in use.

                                                                                                                  ShortTime period when the contact point was/is in use
                                                                                                                  Control0..1
                                                                                                                  TypePeriod
                                                                                                                  Is Modifierfalse
                                                                                                                  Summarytrue
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  424. Patient.contact.address
                                                                                                                  Definition

                                                                                                                  Address for the contact person.

                                                                                                                  ShortAddress for the contact person
                                                                                                                  Control0..0
                                                                                                                  TypeAddress
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Requirements

                                                                                                                  Need to keep track where the contact person can be contacted per postal mail or visited.

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

                                                                                                                  Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                                                  Shortmale | female | other | unknown
                                                                                                                  Control0..0
                                                                                                                  BindingThe codes SHALL be taken from AdministrativeGender
                                                                                                                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                                                  The gender of a person used for administrative purposes.

                                                                                                                  Typecode
                                                                                                                  Is Modifierfalse
                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                  Summaryfalse
                                                                                                                  Requirements

                                                                                                                  Needed to address the person correctly.

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

                                                                                                                  Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                                                  ShortOrganization that is associated with the contact
                                                                                                                  Control0..0
                                                                                                                  This element is affected by the following invariants: pat-1
                                                                                                                  TypeReference(Organization)
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Requirements

                                                                                                                  For guardians or business related contacts, the organization is relevant.

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

                                                                                                                  The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                                                  ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                                                  Control0..0
                                                                                                                  TypePeriod
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  432. Patient.communication
                                                                                                                  Definition

                                                                                                                  A language which may be used to communicate with the patient about his or her health.

                                                                                                                  ShortA language which may be used to communicate with the patient about his or her health
                                                                                                                  Comments

                                                                                                                  If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                                                  Control0..0
                                                                                                                  TypeBackboneElement
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Requirements

                                                                                                                  If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

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

                                                                                                                  Patient's nominated care provider.

                                                                                                                  ShortPatient's nominated primary care provider
                                                                                                                  Comments

                                                                                                                  This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                                                                  Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                                                                  Control0..0
                                                                                                                  TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Alternate NamescareProvider
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  441. Patient.managingOrganization
                                                                                                                  Definition

                                                                                                                  Organization that is the custodian of the patient record.

                                                                                                                  ShortOrganization that is the custodian of the patient record
                                                                                                                  Comments

                                                                                                                  There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                                                  Control0..0
                                                                                                                  TypeReference(Organization)
                                                                                                                  Is Modifierfalse
                                                                                                                  Summarytrue
                                                                                                                  Requirements

                                                                                                                  Need to know who recognizes this patient record, manages and updates it.

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

                                                                                                                  Link to another patient resource that concerns the same actual patient.

                                                                                                                  ShortLink to another patient resource that concerns the same actual person
                                                                                                                  Comments

                                                                                                                  There is no assumption that linked patient records have mutual links.

                                                                                                                  Control0..0
                                                                                                                  TypeBackboneElement
                                                                                                                  Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                                                  Summarytrue
                                                                                                                  Requirements

                                                                                                                  There are multiple use cases:

                                                                                                                  • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                                                  • Distribution of patient information across multiple servers.
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))