{
  "description": "Padronização de uso de nomes de indivíduo no Brasil.",
  "_filename": "StructureDefinition-BRNomeIndividuo-1.0.json",
  "package_name": "br.ufg.cgis.rnds-lite",
  "date": "2020-03-11T04:13:12.172535+00:00",
  "derivation": "constraint",
  "meta": {
    "lastUpdated": "2020-03-11T04:13:12.682+00:00"
  },
  "publisher": "CGIS",
  "fhirVersion": "4.0.1",
  "name": "BRNomeIndividuo",
  "mapping": [ {
    "uri": "http://hl7.org/v2",
    "name": "HL7 v2 Mapping",
    "identity": "v2"
  }, {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  }, {
    "uri": "http://www.omg.org/spec/ServD/1.0/",
    "name": "ServD",
    "identity": "servd"
  } ],
  "abstract": false,
  "type": "HumanName",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Nome de Indivíduos",
  "package_version": "0.2.1",
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName",
      "min": 1,
      "definition": "Nome(s) associado(s) ao indivíduo.",
      "isModifier": false,
      "short": "Nome do Indivíduo",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "XPN",
        "identity": "v2"
      }, {
        "map": "EN (actually, PN)",
        "identity": "rim"
      }, {
        "map": "ProviderName",
        "identity": "servd"
      } ],
      "mustSupport": true,
      "max": "*",
      "id": "HumanName",
      "condition": [ "ele-1" ],
      "comment": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "HumanName"
      }
    }, {
      "path": "HumanName.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "HumanName.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "HumanName.extension",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "HumanName.extension",
      "comment": "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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.use",
      "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
      "min": 1,
      "definition": "official: nome oficial atual, conforme registrado na certidão de registro civil mais atual do indivíduo.\r\nmaiden: nome oficial de solteiro(a), quando houve uma alteração de nome decorrente de uma união de qualquer tipo.\r\nold: nome oficial anterior, quando houve uma alteração de nome em uma certidão de registro civil ou decisão judicial decorrente de qualquer outra situação que não seja uma união.\r\nusual: nome social.\r\ntemp: nome temporário, como aqueles utilizados em programas de proteção a testemunhas.\r\nanonymous: uso exclusivo para anonimização de registros de indivíudos.",
      "isModifier": true,
      "short": "Tipo de Nome",
      "mapping": [ {
        "map": "XPN.7, but often indicated by which field contains the name",
        "identity": "v2"
      }, {
        "map": "unique(./use)",
        "identity": "rim"
      }, {
        "map": "./NamePurpose",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "mustSupport": true,
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "NameUse"
        } ],
        "description": "The use of a human name."
      },
      "max": "1",
      "id": "HumanName.use",
      "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "HumanName.use"
      },
      "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.text",
      "requirements": "A renderable, unencoded form.",
      "min": 1,
      "definition": "Nome completo do indivíduo, composto pelo nome próprio, que pode ser mais de um quando trata-se de um nome composto, pelo sobrenome e pelo sufixo (Filho, Neto, Júnior etc.) quando aplicável.",
      "isModifier": false,
      "short": "Nome Completo",
      "mapping": [ {
        "map": "implied by XPN.11",
        "identity": "v2"
      }, {
        "map": "./formatted",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "mustSupport": true,
      "max": "1",
      "id": "HumanName.text",
      "comment": "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.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "HumanName.text"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.family",
      "min": 0,
      "definition": "O(s) sobrenome(s) do indivíduo, quando é possível coletar esta informação desagregada.",
      "isModifier": false,
      "short": "Sobrenome",
      "mapping": [ {
        "map": "XPN.1/FN.1",
        "identity": "v2"
      }, {
        "map": "./part[partType = FAM]",
        "identity": "rim"
      }, {
        "map": "./FamilyName",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "mustSupport": true,
      "alias": [ "surname" ],
      "max": "1",
      "id": "HumanName.family",
      "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
      "base": {
        "max": "1",
        "min": 0,
        "path": "HumanName.family"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.given",
      "min": 0,
      "definition": "O nome próprio do indivíduo, incluindo todos aqueles que não são o sobrenome no caso de nomes compostos, quando é possível coletar esta informação desagregada.",
      "isModifier": false,
      "short": "Nome Próprio",
      "mapping": [ {
        "map": "XPN.2 + XPN.3",
        "identity": "v2"
      }, {
        "map": "./part[partType = GIV]",
        "identity": "rim"
      }, {
        "map": "./GivenNames",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "mustSupport": true,
      "alias": [ "first name", "middle name" ],
      "max": "1",
      "id": "HumanName.given",
      "comment": "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.",
      "orderMeaning": "Given Names appear in the correct order for presenting the name",
      "base": {
        "max": "*",
        "min": 0,
        "path": "HumanName.given"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.prefix",
      "min": 0,
      "definition": "Prefixo do nome tipicamente utilizado quando se adquire títulos acadêmicos (Prof. ou Dr.), estados maritais (Sr., Sra., Srta.) etc., e é possível coletar esta informação.",
      "isModifier": false,
      "short": "Prefixo do Nome",
      "mapping": [ {
        "map": "XPN.5",
        "identity": "v2"
      }, {
        "map": "./part[partType = PFX]",
        "identity": "rim"
      }, {
        "map": "./TitleCode",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "mustSupport": true,
      "max": "*",
      "id": "HumanName.prefix",
      "orderMeaning": "Prefixes appear in the correct order for presenting the name",
      "base": {
        "max": "*",
        "min": 0,
        "path": "HumanName.prefix"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.suffix",
      "min": 0,
      "definition": "Sufixo do nome, tipicamente utilizado para identificar a geração do indivíduo (Filho, Neto, Júnior etc.), quando é possível coletar esta informação desagregada.",
      "isModifier": false,
      "short": "Sufixo do Nome",
      "mapping": [ {
        "map": "XPN/4",
        "identity": "v2"
      }, {
        "map": "./part[partType = SFX]",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "mustSupport": true,
      "max": "*",
      "id": "HumanName.suffix",
      "orderMeaning": "Suffixes appear in the correct order for presenting the name",
      "base": {
        "max": "*",
        "min": 0,
        "path": "HumanName.suffix"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.period",
      "requirements": "Allows names to be placed in historical context.",
      "min": 0,
      "definition": "Indica a data inicial e final do uso do nome.",
      "isModifier": false,
      "short": "Período de Uso do Nome",
      "mapping": [ {
        "map": "XPN.13 + XPN.14",
        "identity": "v2"
      }, {
        "map": "./usablePeriod[type=\"IVL\"]",
        "identity": "rim"
      }, {
        "map": "./StartDate and ./EndDate",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "Period"
      } ],
      "mustSupport": true,
      "max": "1",
      "id": "HumanName.period",
      "base": {
        "max": "1",
        "min": 0,
        "path": "HumanName.period"
      },
      "isSummary": true
    }, {
      "path": "HumanName.period.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "HumanName.period.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "HumanName.period.extension",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "HumanName.period.extension",
      "comment": "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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.period.start",
      "min": 0,
      "definition": "Quando o uso do nome iniciou.",
      "isModifier": false,
      "short": "Data Inicial",
      "mapping": [ {
        "map": "DR.1",
        "identity": "v2"
      }, {
        "map": "./low",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "dateTime"
      } ],
      "mustSupport": true,
      "max": "1",
      "id": "HumanName.period.start",
      "condition": [ "per-1" ],
      "comment": "If the low element is missing, the meaning is that the low boundary is not known.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Period.start"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "HumanName.period.end",
      "min": 0,
      "definition": "Quando o uso do nome terminou.",
      "isModifier": false,
      "short": "Data Final",
      "mapping": [ {
        "map": "DR.2",
        "identity": "v2"
      }, {
        "map": "./high",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "dateTime"
      } ],
      "mustSupport": true,
      "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
      "max": "1",
      "id": "HumanName.period.end",
      "condition": [ "per-1" ],
      "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Period.end"
      },
      "isSummary": true
    } ]
  },
  "status": "active",
  "language": "pt-BR",
  "id": "30b1538b-c842-41ae-96e7-4c2a27408f96",
  "kind": "complex-type",
  "url": "http://www.saude.gov.br/fhir/r4/StructureDefinition/BRNomeIndividuo-1.0",
  "version": "0.2.1",
  "differential": {
    "element": [ {
      "id": "HumanName",
      "min": 1,
      "path": "HumanName",
      "short": "Nome do Indivíduo",
      "definition": "Nome(s) associado(s) ao indivíduo.",
      "mustSupport": true
    }, {
      "id": "HumanName.use",
      "min": 1,
      "path": "HumanName.use",
      "short": "Tipo de Nome",
      "definition": "official: nome oficial atual, conforme registrado na certidão de registro civil mais atual do indivíduo.\r\nmaiden: nome oficial de solteiro(a), quando houve uma alteração de nome decorrente de uma união de qualquer tipo.\r\nold: nome oficial anterior, quando houve uma alteração de nome em uma certidão de registro civil ou decisão judicial decorrente de qualquer outra situação que não seja uma união.\r\nusual: nome social.\r\ntemp: nome temporário, como aqueles utilizados em programas de proteção a testemunhas.\r\nanonymous: uso exclusivo para anonimização de registros de indivíudos.",
      "mustSupport": true,
      "isModifierReason": "É importante que as aplicações saibam interpretar corretamente o tipo de nome que está sendo utilizado, para dar a tratativa correta ao indivíduo."
    }, {
      "id": "HumanName.text",
      "min": 1,
      "path": "HumanName.text",
      "short": "Nome Completo",
      "definition": "Nome completo do indivíduo, composto pelo nome próprio, que pode ser mais de um quando trata-se de um nome composto, pelo sobrenome e pelo sufixo (Filho, Neto, Júnior etc.) quando aplicável.",
      "mustSupport": true
    }, {
      "id": "HumanName.family",
      "path": "HumanName.family",
      "short": "Sobrenome",
      "definition": "O(s) sobrenome(s) do indivíduo, quando é possível coletar esta informação desagregada.",
      "mustSupport": true
    }, {
      "id": "HumanName.given",
      "max": "1",
      "path": "HumanName.given",
      "short": "Nome Próprio",
      "definition": "O nome próprio do indivíduo, incluindo todos aqueles que não são o sobrenome no caso de nomes compostos, quando é possível coletar esta informação desagregada.",
      "mustSupport": true
    }, {
      "id": "HumanName.prefix",
      "path": "HumanName.prefix",
      "short": "Prefixo do Nome",
      "definition": "Prefixo do nome tipicamente utilizado quando se adquire títulos acadêmicos (Prof. ou Dr.), estados maritais (Sr., Sra., Srta.) etc., e é possível coletar esta informação.",
      "mustSupport": true
    }, {
      "id": "HumanName.suffix",
      "path": "HumanName.suffix",
      "short": "Sufixo do Nome",
      "definition": "Sufixo do nome, tipicamente utilizado para identificar a geração do indivíduo (Filho, Neto, Júnior etc.), quando é possível coletar esta informação desagregada.",
      "mustSupport": true
    }, {
      "id": "HumanName.period",
      "path": "HumanName.period",
      "short": "Período de Uso do Nome",
      "definition": "Indica a data inicial e final do uso do nome.",
      "mustSupport": true
    }, {
      "id": "HumanName.period.start",
      "path": "HumanName.period.start",
      "short": "Data Inicial",
      "definition": "Quando o uso do nome iniciou.",
      "mustSupport": true
    }, {
      "id": "HumanName.period.end",
      "path": "HumanName.period.end",
      "short": "Data Final",
      "definition": "Quando o uso do nome terminou.",
      "mustSupport": true
    } ]
  },
  "contact": [ {
    "name": "CGIS",
    "telecom": [ {
      "value": "https://cgis.ufg.br/",
      "system": "url"
    }, {
      "value": "fabio@inf.ufg.br",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName"
}