Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS
0.1.0 - STU1
Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS - Compilação de desenvolvimento local (v0.1.0) construída pelas ferramentas de compilação FHIR (HL7® FHIR® Standard). Veja o Diretório de versões publicadas
| Official URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRegistroImunobiologicoAdministradoCampanha-2.0 | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: BRRegistroImunobiologicoAdministradoCampanha | ||
Documento que aprepresenta o registro da administração de imunobiológicos em campanha vacinal (Portaria Conjunta SAES/SVSA/SEIDIGI Nº 25, de 27 de Novembro de 2023).
Usos:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de documento |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | dateTime | Data/hora de geração do documento |
![]() ![]() |
SΣ | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha |
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Vínculo: DocumentRelationshipType (required): The type of relationship between documents. | |
![]() ![]() ![]() |
1..1 | Target of the relationship | ||
![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() ![]() |
SC | 1..1 | BackboneElement | Seções do documento Constraints: cmp-1, cmp-2 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SC | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | a norma FHIR |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | error | Composition | 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 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.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()
|
This structure is derived from Composition
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado |
![]() ![]() |
0..0 | Version-independent identifier for the Composition | ||
![]() ![]() |
S | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento |
![]() ![]() |
S | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de documento |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() |
0..0 | Plain text representation of the concept | ||
![]() ![]() |
S | 0..0 | Modalidade Assistencial | |
![]() ![]() |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
0..0 | Context of the Composition | ||
![]() ![]() |
S | 1..1 | dateTime | Data/hora de geração do documento |
![]() ![]() |
S | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
S | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha |
![]() ![]() |
0..0 | As defined by affinity domain | ||
![]() ![]() |
0..0 | Attests to accuracy of composition | ||
![]() ![]() |
0..0 | Organization which maintains the composition | ||
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |
![]() ![]() |
0..0 | The clinical service(s) being documented | ||
![]() ![]() |
S | 1..1 | BackboneElement | Seções do documento |
![]() ![]() ![]() |
0..0 | Label for section (e.g. for ToC) | ||
![]() ![]() ![]() |
0..0 | Classification of section (recommended) | ||
![]() ![]() ![]() |
0..0 | Who and/or what authored the section | ||
![]() ![]() ![]() |
0..0 | Who/what the section is about, when it is not about the subject of composition | ||
![]() ![]() ![]() |
0..0 | Text summary of the section, for human interpretation | ||
![]() ![]() ![]() |
0..0 | working | snapshot | changes | ||
![]() ![]() ![]() |
0..0 | Order of section entries | ||
![]() ![]() ![]() |
S | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() ![]() |
0..0 | Why the section is empty | ||
![]() ![]() ![]() |
0..0 | Nested Section | ||
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado | ||||
![]() ![]() |
Σ | 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.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!SΣ | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de 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 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Data/hora de geração do documento | ||||
![]() ![]() |
SΣ | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() |
SΣ | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha | ||||
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |||||
![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Vínculo: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Target of the relationship | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
SC | 1..1 | BackboneElement | Seções do documento Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SC | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentação para este formato | ||||||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | a norma FHIR |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | a norma FHIR |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | error | Composition | 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 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.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()
|
This structure is derived from Composition
Resumo
Obrigatório: 11 elementos(1 aninhado obrigatoriamente elemento)
Deve ser suportado: 12 elementos
Fixo: 1 elemento
Proibido: 35 elementos
Estruturas
Esta estrutura refere-se a estas outras estruturas:
Maturidade: 1
Key Elements View
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de documento |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | dateTime | Data/hora de geração do documento |
![]() ![]() |
SΣ | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 |
![]() ![]() |
SΣ | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha |
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Vínculo: DocumentRelationshipType (required): The type of relationship between documents. | |
![]() ![]() ![]() |
1..1 | Target of the relationship | ||
![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() ![]() |
SC | 1..1 | BackboneElement | Seções do documento Constraints: cmp-1, cmp-2 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SC | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | a norma FHIR |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | a norma FHIR |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | error | Composition | 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 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.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()
|
Differential View
This structure is derived from Composition
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado |
![]() ![]() |
0..0 | Version-independent identifier for the Composition | ||
![]() ![]() |
S | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento |
![]() ![]() |
S | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de documento |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() |
0..0 | Plain text representation of the concept | ||
![]() ![]() |
S | 0..0 | Modalidade Assistencial | |
![]() ![]() |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
0..0 | Context of the Composition | ||
![]() ![]() |
S | 1..1 | dateTime | Data/hora de geração do documento |
![]() ![]() |
S | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
S | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha |
![]() ![]() |
0..0 | As defined by affinity domain | ||
![]() ![]() |
0..0 | Attests to accuracy of composition | ||
![]() ![]() |
0..0 | Organization which maintains the composition | ||
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |
![]() ![]() |
0..0 | The clinical service(s) being documented | ||
![]() ![]() |
S | 1..1 | BackboneElement | Seções do documento |
![]() ![]() ![]() |
0..0 | Label for section (e.g. for ToC) | ||
![]() ![]() ![]() |
0..0 | Classification of section (recommended) | ||
![]() ![]() ![]() |
0..0 | Who and/or what authored the section | ||
![]() ![]() ![]() |
0..0 | Who/what the section is about, when it is not about the subject of composition | ||
![]() ![]() ![]() |
0..0 | Text summary of the section, for human interpretation | ||
![]() ![]() ![]() |
0..0 | working | snapshot | changes | ||
![]() ![]() ![]() |
0..0 | Order of section entries | ||
![]() ![]() ![]() |
S | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() ![]() |
0..0 | Why the section is empty | ||
![]() ![]() ![]() |
0..0 | Nested Section | ||
Documentação para este formato | ||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
Snapshot View
| Nome | Bandeiras | Card. | Tipo | Descrição e condicionalismos Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
S | 0..* | Composition | Registro de Imunobiológico Administrado | ||||
![]() ![]() |
Σ | 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.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!SΣ | 1..1 | code | final | entered-in-error Vínculo: CompositionStatus (required): Estado do documento | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Tipo de documento Vínculo: Tipo de Documento (preferred): Tipo de 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 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Sujeito da composição | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Data/hora de geração do documento | ||||
![]() ![]() |
SΣ | 1..* | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Exemplo General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Exemplo General: 123456 | ||||
![]() ![]() |
SΣ | 1..1 | string | Título do documento Valor fixo: Registro de Imunobiologico Administrado na Campanha | ||||
![]() ![]() |
0..1 | BackboneElement | Relação a outros documentos | |||||
![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Vínculo: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Target of the relationship | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
SC | 1..1 | BackboneElement | Seções do documento Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SC | 1..1 | Reference(Imunobiológico Administrado em Campanha) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Fatia: Não ordenado, Aberto por value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentação para este formato | ||||||||
| Caminho | Estado | Utilização | Conjunto de valores | Versão | Fonte |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | a norma FHIR |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | a norma FHIR |
| Composition.type | Base | preferred | Tipo de Documento | 📦0.1.0 | este IG |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | a norma FHIR |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | a norma FHIR |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Id | Grau | Caminho(s) | Descrição | Expressão |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | error | Composition | 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 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | A resource should have narrative for robust management |
text.`div`.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()
|
This structure is derived from Composition
Resumo
Obrigatório: 11 elementos(1 aninhado obrigatoriamente elemento)
Deve ser suportado: 12 elementos
Fixo: 1 elemento
Proibido: 35 elementos
Estruturas
Esta estrutura refere-se a estas outras estruturas:
Maturidade: 1
Other representations of profile: CSV, Excel, Schematron