{ "resourceType": "StructureDefinition", "meta": { "lastUpdated": "2020-03-11T04:06:40.866+00:00" }, "language": "pt-BR", "url": "http://www.saude.gov.br/fhir/r4/StructureDefinition/BREndereco-1.0", "version": "1.0", "name": "BREndereco", "title": "Endereço", "status": "active", "date": "2020-03-11T04:06:40.3767721+00:00", "publisher": "Ministério da Saúde do Brasil", "description": "Padronização de endereços no Brasil.", "fhirVersion": "4.0.0", "kind": "complex-type", "abstract": false, "type": "Address", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address", "derivation": "constraint", "snapshot": { "element": [ { "id": "Address", "path": "Address", "short": "Dados de Endereçamento", "definition": "Dados do(s) endereço(s) onde o sujeito do endereço pode ser localizado.", "comment": "Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "min": 0, "max": "*", "base": { "path": "Address", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" } ] }, { "id": "Address.id", "path": "Address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.extension", "path": "Address.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Address.use", "path": "Address.use", "short": "Uso do Endereço", "definition": "home: endereço residencial atual.\r\nwork: endereço comercial ou de trabalho atual.\r\ntemp: endereço temporário, como um hotel, a casa de amigos ou familiares, uma instalação/edificação provisória, etc.\r\nold: endereço anterior.", "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "requirements": "Allows an appropriate address to be chosen from a list of many.", "min": 0, "max": "1", "base": { "path": "Address.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "home" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "description": "The use of an address.", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "id": "Address.type", "path": "Address.type", "short": "Tipo de Endereço", "definition": "physical: um endereço físico de um edificação ou espaço geográfico real, como de uma casa, prédio, loja, galpão, lote, etc.\r\npostal: um endereço virtual, como de uma Caixa Postal ou serviço de logística de mercadorias, p.ex.", "comment": "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](location.html#) resource).", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "both" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "description": "The type of an address (physical / postal).", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ] }, { "id": "Address.text", "path": "Address.text", "short": "Text representation of the address", "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.", "comment": "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.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "0", "base": { "path": "Address.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ] }, { "id": "Address.line", "path": "Address.line", "slicing": { "discriminator": [ { "type": "value", "path": "line" } ], "rules": "open" }, "short": "Endereço", "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 1, "max": "*", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.line:streetType", "path": "Address.line", "sliceName": "streetType", "short": "Tipo de Logradouro", "definition": "Tipo de logradouro do endereço.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "required", "description": "Tipo de Logradouro", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoLogradouro-1.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.line:street", "path": "Address.line", "sliceName": "street", "short": "Logradouro", "definition": "Logradouro do endereço (ex.: Visconde do Rio Branco, das Laranjeiras, QRSW 8 Bloco A-1) . Quando não for possível utilizar o elemento streetType, incluir textualmente no início do nome do logradouro o tipo de logradouro abreviado (ex.: R. Visconde do Rio Branco, Av. das Laranjeiras, Quadra QRSW 8 Bloco A-1).", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.line:number", "path": "Address.line", "sliceName": "number", "short": "Número", "definition": "Número do endereço.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.line:complement", "path": "Address.line", "sliceName": "complement", "short": "Complemento", "definition": "Complemento do endereço, como o nome do edifício, bloco, número do apartamento, número da sala etc.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.line:neighborhood", "path": "Address.line", "sliceName": "neighborhood", "short": "Bairro", "definition": "Bairro do endereço.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "id": "Address.city", "path": "Address.city", "short": "Município", "definition": "Município do endereço.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "alias": [ "Municpality" ], "min": 1, "max": "1", "base": { "path": "Address.city", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Erewhon" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "strength": "required", "description": "Município", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "id": "Address.district", "path": "Address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (county).", "comment": "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.", "alias": [ "County" ], "min": 0, "max": "0", "base": { "path": "Address.district", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Madison" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] }, { "id": "Address.state", "path": "Address.state", "short": "UF", "definition": "Unidade Federativa (estados ou Distrito Federal) do endereço.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "alias": [ "Province", "Territory" ], "min": 1, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "required", "description": "Unidade Federativa", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ] }, { "id": "Address.postalCode", "path": "Address.postalCode", "short": "CEP", "definition": "Código de Endereçamento Postal. Utilizar a máscara XXXXX-XXXX.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "alias": [ "Zip" ], "min": 1, "max": "1", "base": { "path": "Address.postalCode", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "9132" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "id": "Address.country", "path": "Address.country", "short": "Country (e.g. can be ISO 3166 2 or 3 letter code)", "definition": "Country - a nation as commonly understood or generally accepted.", "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "min": 0, "max": "0", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "id": "Address.period", "path": "Address.period", "short": "Período do Endereço", "definition": "Período em que o endereço foi utilizado.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "requirements": "Allows addresses to be placed in historical context.", "min": 0, "max": "1", "base": { "path": "Address.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "example": [ { "label": "General", "valuePeriod": { "start": "2010-03-23", "end": "2010-07-01" } } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)", "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "Address.period.id", "path": "Address.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.period.extension", "path": "Address.period.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Address.period.start", "path": "Address.period.start", "short": "Data de Inicio do Endereço", "definition": "Data em que o endereço foi cadastrado ou começou a ser utilizado.", "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1", "per-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "id": "Address.period.end", "path": "Address.period.end", "short": "Data de Término do Endereço", "definition": "Data em que o endereço foi desativado ou parou de ser utilizado.", "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.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "ele-1", "per-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] } ] }, "differential": { "element": [ { "id": "Address", "path": "Address", "short": "Dados de Endereçamento", "definition": "Dados do(s) endereço(s) onde o sujeito do endereço pode ser localizado.", "mustSupport": true }, { "id": "Address.use", "path": "Address.use", "short": "Uso do Endereço", "definition": "home: endereço residencial atual.\r\nwork: endereço comercial ou de trabalho atual.\r\ntemp: endereço temporário, como um hotel, a casa de amigos ou familiares, uma instalação/edificação provisória, etc.\r\nold: endereço anterior.", "mustSupport": true }, { "id": "Address.type", "path": "Address.type", "short": "Tipo de Endereço", "definition": "physical: um endereço físico de um edificação ou espaço geográfico real, como de uma casa, prédio, loja, galpão, lote, etc.\r\npostal: um endereço virtual, como de uma Caixa Postal ou serviço de logística de mercadorias, p.ex.", "mustSupport": true }, { "id": "Address.text", "path": "Address.text", "max": "0" }, { "id": "Address.line", "path": "Address.line", "slicing": { "discriminator": [ { "type": "value", "path": "line" } ], "rules": "open" }, "short": "Endereço", "min": 1, "mustSupport": true }, { "id": "Address.line:streetType", "path": "Address.line", "sliceName": "streetType", "short": "Tipo de Logradouro", "definition": "Tipo de logradouro do endereço.", "max": "1", "mustSupport": true, "binding": { "strength": "required", "description": "Tipo de Logradouro", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoLogradouro-1.0" } }, { "id": "Address.line:street", "path": "Address.line", "sliceName": "street", "short": "Logradouro", "definition": "Logradouro do endereço (ex.: Visconde do Rio Branco, das Laranjeiras, QRSW 8 Bloco A-1) . Quando não for possível utilizar o elemento streetType, incluir textualmente no início do nome do logradouro o tipo de logradouro abreviado (ex.: R. Visconde do Rio Branco, Av. das Laranjeiras, Quadra QRSW 8 Bloco A-1).", "min": 1, "max": "1", "mustSupport": true }, { "id": "Address.line:number", "path": "Address.line", "sliceName": "number", "short": "Número", "definition": "Número do endereço.", "min": 1, "max": "1", "mustSupport": true }, { "id": "Address.line:complement", "path": "Address.line", "sliceName": "complement", "short": "Complemento", "definition": "Complemento do endereço, como o nome do edifício, bloco, número do apartamento, número da sala etc.", "max": "1", "mustSupport": true }, { "id": "Address.line:neighborhood", "path": "Address.line", "sliceName": "neighborhood", "short": "Bairro", "definition": "Bairro do endereço.", "min": 1, "max": "1", "mustSupport": true }, { "id": "Address.city", "path": "Address.city", "short": "Município", "definition": "Município do endereço.", "min": 1, "binding": { "strength": "required", "description": "Município", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0" } }, { "id": "Address.district", "path": "Address.district", "max": "0" }, { "id": "Address.state", "path": "Address.state", "short": "UF", "definition": "Unidade Federativa (estados ou Distrito Federal) do endereço.", "min": 1, "mustSupport": true, "binding": { "strength": "required", "description": "Unidade Federativa", "valueSet": "http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0" } }, { "id": "Address.postalCode", "path": "Address.postalCode", "short": "CEP", "definition": "Código de Endereçamento Postal. Utilizar a máscara XXXXX-XXXX.", "min": 1, "mustSupport": true }, { "id": "Address.country", "path": "Address.country", "max": "0" }, { "id": "Address.period", "path": "Address.period", "short": "Período do Endereço", "definition": "Período em que o endereço foi utilizado.", "mustSupport": true }, { "id": "Address.period.start", "path": "Address.period.start", "short": "Data de Inicio do Endereço", "definition": "Data em que o endereço foi cadastrado ou começou a ser utilizado.", "mustSupport": true }, { "id": "Address.period.end", "path": "Address.period.end", "short": "Data de Término do Endereço", "definition": "Data em que o endereço foi desativado ou parou de ser utilizado.", "mustSupport": true } ] } }