Guia de implementação do Core do Brasil: Release 1 - BR Realm | STU1
1.7.1 - STU1
This page is part of the Core do Brasil (v1.7.1: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| URL Canônica: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-bundle-documento | Versão: 1.7.1 | |||
| Draft as of 2026-10-21 | Nome computável: BRCoreBundleDocumento | |||
Documento clínico FHIR: Bundle do tipo document cuja primeira entrada é uma br-core-composition (ou perfil derivado, como o br-core-sumarioalta), seguida dos recursos que ela referencia. Segue as regras do clinical-document-bundle do FHIR Clinical Documents (HL7, STU1 1.0.1): identificador persistente, timestamp e Composition como primeira entrada.
Este perfil define o documento clínico FHIR no BR-Core: um Bundle do tipo document, imutável, cuja primeira entrada é uma Composition derivada do br-core-composition, como o br-core-sumarioalta, seguida de todos os recursos que ela referencia.
As regras seguem o perfil internacional clinical-document-bundle do FHIR Clinical Documents (HL7, STU1 1.0.1):
identifier persistente (system e value);type = document;timestamp obrigatório e igual ou posterior a Composition.date;fullUrl em todas as entradas.Envio de documentos clínicos, como o Sumário de Alta, em substituição aos perfis de documento próprios da RNDS. Retificação: novo documento, com novo identifier, e Composition.relatesTo (replaces) apontando para a Composition anterior.
Usos:
You can also check for usages in the FHIR IG Statistics
Descrição de perfis, diferenciais, instantâneos e como as diferentes apresentações funcionam.
Esta estrutura é derivada de Bundle
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: br-core-bdoc-1, br-core-bdoc-2 |
![]() ![]() |
S | 1..1 | Identifier | Identificador persistente do documento |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | document Padrão necessário: document |
![]() ![]() |
S | 1..1 | instant | Data e hora de montagem do documento |
![]() ![]() |
S | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource |
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Composition do documento (primeira entrada) |
![]() ![]() ![]() ![]() |
1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() |
S | 0..1 | Signature | Assinatura digital do documento |
Documentação para este formato | ||||
| Id | Grau | Caminho(s) | Descrição | Expressão |
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, br-core-bdoc-1, br-core-bdoc-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣ | 1..1 | Identifier | Identificador persistente do documento |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Vínculo: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | code | document Vínculo: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Padrão necessário: document |
![]() ![]() |
SΣ | 1..1 | instant | Data e hora de montagem do documento |
![]() ![]() |
SΣC | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Composition do documento (primeira entrada) Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
![]() ![]() |
SΣ | 0..1 | Signature | Assinatura digital do documento |
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | a norma FHIR |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | a norma FHIR |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composicao | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composicao | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, br-core-bdoc-1, br-core-bdoc-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Vínculo: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣ | 1..1 | Identifier | Identificador persistente do documento | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Vínculo: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Vínculo: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
SΣ | 1..1 | code | document Vínculo: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Padrão necessário: document | ||||
![]() ![]() |
SΣ | 1..1 | instant | Data e hora de montagem do documento | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
SΣC | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Ver link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Composition do documento (primeira entrada) Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Ver link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
![]() ![]() |
SΣ | 0..1 | Signature | Assinatura digital do documento | ||||
Documentação para este formato | ||||||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | a norma FHIR |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | a norma FHIR |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | a norma FHIR |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | a norma FHIR |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composicao | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composicao | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Visão diferencial
Esta estrutura é derivada de Bundle
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: br-core-bdoc-1, br-core-bdoc-2 |
![]() ![]() |
S | 1..1 | Identifier | Identificador persistente do documento |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | document Padrão necessário: document |
![]() ![]() |
S | 1..1 | instant | Data e hora de montagem do documento |
![]() ![]() |
S | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource |
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Composition do documento (primeira entrada) |
![]() ![]() ![]() ![]() |
1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
0..0 | Search related information | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() |
S | 0..1 | Signature | Assinatura digital do documento |
Documentação para este formato | ||||
| Id | Grau | Caminho(s) | Descrição | Expressão |
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
Visualização de elementos -chave
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, br-core-bdoc-1, br-core-bdoc-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣ | 1..1 | Identifier | Identificador persistente do documento |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Vínculo: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | code | document Vínculo: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Padrão necessário: document |
![]() ![]() |
SΣ | 1..1 | instant | Data e hora de montagem do documento |
![]() ![]() |
SΣC | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Composition do documento (primeira entrada) Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation |
![]() ![]() |
SΣ | 0..1 | Signature | Assinatura digital do documento |
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | a norma FHIR |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | a norma FHIR |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composicao | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composicao | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Visualização instantânea
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Documento clínico (Bundle document) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, br-core-bdoc-1, br-core-bdoc-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Vínculo: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣ | 1..1 | Identifier | Identificador persistente do documento | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Vínculo: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Vínculo: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
SΣ | 1..1 | code | document Vínculo: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Padrão necessário: document | ||||
![]() ![]() |
SΣ | 1..1 | instant | Data e hora de montagem do documento | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
SΣC | 1..* | BackboneElement | Entradas do documento Fatia: Não ordenado, Aberto por type:resource Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() |
Conteúdo/regras para todas as fatias | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Ver link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Composition do documento (primeira entrada) Constraints: bdl-5, bdl-8 Esta ordem de repetição de elementos: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Ver link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | BRCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
![]() ![]() |
SΣ | 0..1 | Signature | Assinatura digital do documento | ||||
Documentação para este formato | ||||||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | a norma FHIR |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | a norma FHIR |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | a norma FHIR |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | a norma FHIR |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | a norma FHIR |
| Bundle.entry:composicao.request.method | Base | required | HTTPVerb | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composicao | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composicao | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| br-core-bdoc-1 | error | Bundle | O timestamp do documento DEVE ser igual ou posterior à data da Composition (primeira entrada). |
timestamp >= entry.first().resource.date
|
| br-core-bdoc-2 | error | Bundle | Todas as entradas do documento DEVEM ter fullUrl. |
entry.all(fullUrl.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Outras representações de perfil: CSV, Excel, Schematron