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 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRegistroImunobiologicoAdministradoRotina-2.0 | Version: 0.1.0 | |||
Standards status: Informative | Maturity Level: 1 | Computable Name: BRRegistroImunobiologicoAdministradoRotina |
Documento que aprepresenta o registro da administração de imunobiológicos na rotina de imunização (Portaria Conjunta SAES/SVSA/SEIDIGI Nº 25, de 27 de Novembro de 2023).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado |
identifier | 0..0 | |||
status | S | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento |
type | S | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento |
coding | S | 1..1 | Coding | Code defined by a terminology system |
text | 0..0 | |||
category | S | 0..0 | ||
subject | S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | Identifier | Identificador Nacional do Indivíduo | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
display | 0..0 | |||
encounter | 0..0 | |||
date | S | 1..1 | dateTime | Data e hora do registro no sistema de origem |
author | S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
display | 0..0 | |||
title | S | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina |
confidentiality | 0..0 | |||
attester | 0..0 | |||
custodian | 0..0 | |||
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |
event | 0..0 | |||
section | S | 1..1 | BackboneElement | Seções do documento |
title | 0..0 | |||
code | 0..0 | |||
author | 0..0 | |||
focus | 0..0 | |||
text | 0..0 | |||
mode | 0..0 | |||
orderedBy | 0..0 | |||
entry | S | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 0..0 | |||
identifier | 0..0 | |||
display | 0..0 | |||
emptyReason | 0..0 | |||
section | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | |
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento |
type | SΣ | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
subject | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente |
identifier | Σ | 1..1 | Identifier | Identificador Nacional do Indivíduo |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
date | SΣ | 1..1 | dateTime | Data e hora do registro no sistema de origem |
author | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde |
identifier | Σ | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
title | SΣ | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina |
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
target[x] | 1..1 | Target of the relationship | ||
targetIdentifier | Identifier | |||
targetReference | Reference(Composition) | |||
section | SC | 1..1 | BackboneElement | Seções do documento cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
entry | SC | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | |
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 | |
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!SΣ | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento | ||||
type | SΣ | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
subject | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier | Σ | 1..1 | Identifier | Identificador Nacional do Indivíduo | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
date | SΣ | 1..1 | dateTime | Data e hora do registro no sistema de origem | ||||
author | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier | Σ | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
title | SΣ | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina | ||||
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
target[x] | 1..1 | Target of the relationship | ||||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(Composition) | |||||||
section | SC | 1..1 | BackboneElement | Seções do documento cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entry | SC | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | ||||
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
Id | Grade | Path(s) | Details | Requirements |
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
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Fixed: 1 element
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado |
identifier | 0..0 | |||
status | S | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento |
type | S | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento |
coding | S | 1..1 | Coding | Code defined by a terminology system |
text | 0..0 | |||
category | S | 0..0 | ||
subject | S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | Identifier | Identificador Nacional do Indivíduo | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
display | 0..0 | |||
encounter | 0..0 | |||
date | S | 1..1 | dateTime | Data e hora do registro no sistema de origem |
author | S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
display | 0..0 | |||
title | S | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina |
confidentiality | 0..0 | |||
attester | 0..0 | |||
custodian | 0..0 | |||
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |
event | 0..0 | |||
section | S | 1..1 | BackboneElement | Seções do documento |
title | 0..0 | |||
code | 0..0 | |||
author | 0..0 | |||
focus | 0..0 | |||
text | 0..0 | |||
mode | 0..0 | |||
orderedBy | 0..0 | |||
entry | S | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 0..0 | |||
identifier | 0..0 | |||
display | 0..0 | |||
emptyReason | 0..0 | |||
section | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | |
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento |
type | SΣ | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
subject | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente |
identifier | Σ | 1..1 | Identifier | Identificador Nacional do Indivíduo |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
date | SΣ | 1..1 | dateTime | Data e hora do registro no sistema de origem |
author | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde |
identifier | Σ | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
title | SΣ | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina |
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
target[x] | 1..1 | Target of the relationship | ||
targetIdentifier | Identifier | |||
targetReference | Reference(Composition) | |||
section | SC | 1..1 | BackboneElement | Seções do documento cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
entry | SC | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | |
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 | |
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | S | 0..* | Composition | Registro de Imunobiológico Administrado | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!SΣ | 1..1 | code | final | entered-in-error Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 (required): Estado do documento | ||||
type | SΣ | 1..1 | CodeableConcept | Tipo de documento Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 (preferred): Tipo de documento | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
subject | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | Identificação do paciente | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier | Σ | 1..1 | Identifier | Identificador Nacional do Indivíduo | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
date | SΣ | 1..1 | dateTime | Data e hora do registro no sistema de origem | ||||
author | SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstabelecimentoSaude-1.0) | Estabelecimento de Saúde | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier | Σ | 1..1 | Identifier | Código CNES do Estabelecimento de Saúde. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
title | SΣ | 1..1 | string | Título do documento Fixed Value: Registro de Imunobiologico Administrado na Rotina | ||||
relatesTo | 0..1 | BackboneElement | Relação a outros documentos | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
target[x] | 1..1 | Target of the relationship | ||||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(Composition) | |||||||
section | SC | 1..1 | BackboneElement | Seções do documento cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entry | SC | 1..1 | Reference(Imunobiológico Administrado em Rotina) | Registro de imunização | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoDocumento-1.0 | ||||
Composition.type | preferred | http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumento-1.0 | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
Id | Grade | Path(s) | Details | Requirements |
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
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Fixed: 1 element
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron