Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS
0.1.0 - STU1 Brazil flag

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

Resource Profile: Imunobiológico Administrado em Rotina

Official URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRImunobiologicoAdministrado-3.0 Version: 0.1.0
Standards status: Informative Maturity Level: 1 Computable Name: BRImunobiologicoAdministrado

Representa um imunobiológico administrado em Rotina (Portaria Conjunta SAES/SVSA/SEIDIGI Nº 25, de 27 de Novembro de 2023).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization Imunobiológico Administrado
... extension 2..3 Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... identifier 0..0
... status S 1..1 code Estado da Administração do Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do Evento


Fixed Value: completed
... statusReason 0..0
... vaccineCode S 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... patient S 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) Indivíduo
.... identifier
..... 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
... occurrence[x] S 1..1 dateTime Data da Administração do Imunobiológico
... recorded 0..0
... primarySource 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Logical reference, when literal reference is not known
..... use 0..0
..... type 0..0
..... system 1..1 uri País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países

..... period 0..0
..... assigner 0..0
.... display 0..0
... manufacturer S 0..1 Reference(Organization) Fabricante
.... reference 0..0
.... type 0..0
.... identifier S 1..1 Identifier Logical reference, when literal reference is not known
..... use 0..0
..... type 0..0
..... system S 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value S 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.

..... period 0..0
..... assigner 0..0
.... display 0..0
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicação

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administração

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... doseQuantity 0..0
... performer S 1..1 BackboneElement Profissional Executante
.... function 0..0
.... actor S 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
..... type 0..0
..... identifier 0..0
..... display 0..0
... note 0..0
... reasonCode 0..0
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... extension 1..2 Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... extension 0..3 Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico

.... seriesDoses[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization Imunobiológico Administrado
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode SΣ 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... patient SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) Indivíduo
... occurrence[x] SΣ 1..1 dateTime Data da Administração do Imunobiológico
... primarySource Σ 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
..... system Σ 1..1 uri País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value Σ 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países


Example General: 123456
... manufacturer S 0..1 Reference(Organization) Fabricante
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... system SΣ 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value SΣ 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.


Example General: 123456
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicação

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administração

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... performer SΣ 1..1 BackboneElement Profissional Executante
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... Slices for extension 0..3 Extension Extension
Slice: Unordered, Open by value:url
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
...... url 1..1 uri identifies the meaning of the extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Estado da Administração do Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do Evento


Fixed Value: completed
... vaccineCode SΣ 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... 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 Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... patient SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) 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
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... 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
... occurrence[x] SΣ 1..1 dateTime Data da Administração do Imunobiológico
... primarySource Σ 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... 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 Logical reference, when literal reference is not known
..... 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 País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value Σ 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países


Example General: 123456
... manufacturer S 0..1 Reference(Organization) Fabricante
.... 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 SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... 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 SΣ 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value SΣ 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.


Example General: 123456
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicaçã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
.... coding Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administraçã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
.... coding Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... performer SΣ 1..1 BackboneElement Profissional Executante
.... 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
.... actor SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..3 Extension Extension
Slice: Unordered, Open by value:url
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
...... url 1..1 uri identifies the meaning of the extension
...... value[x] 0..1 Value of extension
....... valueBase64Binary base64Binary
....... valueBoolean boolean
....... valueCanonical canonical(Any)
....... valueCode code
....... valueDate date
....... valueDateTime dateTime
....... valueDecimal decimal
....... valueId id
....... valueInstant instant
....... valueInteger integer
....... valueMarkdown markdown
....... valueOid oid
....... valuePositiveInt positiveInt
....... valueString string
....... valueTime time
....... valueUnsignedInt unsignedInt
....... valueUri uri
....... valueUrl url
....... valueUuid uuid
....... valueAddress Address
....... valueAge Age
....... valueAnnotation Annotation
....... valueAttachment Attachment
....... valueCodeableConcept CodeableConcept
....... valueCoding Coding
....... valueContactPoint ContactPoint
....... valueCount Count
....... valueDistance Distance
....... valueDuration Duration
....... valueHumanName HumanName
....... valueIdentifier Identifier
....... valueMoney Money
....... valuePeriod Period
....... valueQuantity Quantity
....... valueRange Range
....... valueRatio Ratio
....... valueReference Reference(Any)
....... valueSampledData SampledData
....... valueSignature Signature
....... valueTiming Timing
....... valueContactDetail ContactDetail
....... valueContributor Contributor
....... valueDataRequirement DataRequirement
....... valueExpression Expression
....... valueParameterDefinition ParameterDefinition
....... valueRelatedArtifact RelatedArtifact
....... valueTriggerDefinition TriggerDefinition
....... valueUsageContext UsageContext
....... valueDosage Dosage
....... valueMeta Meta
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Mandatory: 18 elements(11 nested mandatory elements)
Must-Support: 17 elements
Fixed: 3 elements
Prohibited: 60 elements

Structures

This structure refers to these other structures:

  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0 (no profile found)
  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0 (no profile found)
  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0 (no profile found)

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0 (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0 (no extension found)

Maturity: 1

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization Imunobiológico Administrado
... extension 2..3 Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... identifier 0..0
... status S 1..1 code Estado da Administração do Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do Evento


Fixed Value: completed
... statusReason 0..0
... vaccineCode S 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... patient S 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) Indivíduo
.... identifier
..... 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
... occurrence[x] S 1..1 dateTime Data da Administração do Imunobiológico
... recorded 0..0
... primarySource 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Logical reference, when literal reference is not known
..... use 0..0
..... type 0..0
..... system 1..1 uri País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países

..... period 0..0
..... assigner 0..0
.... display 0..0
... manufacturer S 0..1 Reference(Organization) Fabricante
.... reference 0..0
.... type 0..0
.... identifier S 1..1 Identifier Logical reference, when literal reference is not known
..... use 0..0
..... type 0..0
..... system S 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value S 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.

..... period 0..0
..... assigner 0..0
.... display 0..0
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicação

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administração

.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 0..0
..... userSelected 0..0
.... text 0..0
... doseQuantity 0..0
... performer S 1..1 BackboneElement Profissional Executante
.... function 0..0
.... actor S 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
..... type 0..0
..... identifier 0..0
..... display 0..0
... note 0..0
... reasonCode 0..0
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... extension 1..2 Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... extension 0..3 Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico

.... seriesDoses[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization Imunobiológico Administrado
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode SΣ 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... patient SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) Indivíduo
... occurrence[x] SΣ 1..1 dateTime Data da Administração do Imunobiológico
... primarySource Σ 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
..... system Σ 1..1 uri País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value Σ 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países


Example General: 123456
... manufacturer S 0..1 Reference(Organization) Fabricante
.... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... system SΣ 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value SΣ 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.


Example General: 123456
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicação

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administração

.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... performer SΣ 1..1 BackboneElement Profissional Executante
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... Slices for extension 0..3 Extension Extension
Slice: Unordered, Open by value:url
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
...... url 1..1 uri identifies the meaning of the extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S 0..* Immunization 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... extension:grupoAtendimento 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento
.... extension:condicaoMaternal S 1..* ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal
.... extension:contatoHanseniase 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Estado da Administração do Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do Evento


Fixed Value: completed
... vaccineCode SΣ 1..1 CodeableConcept Imunobiológico
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico

.... 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 Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... patient SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) 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
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... 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
... occurrence[x] SΣ 1..1 dateTime Data da Administração do Imunobiológico
... primarySource Σ 0..1 boolean Indicação da fonte do registro
... reportOrigin 0..1 CodeableConcept Registro de Origem
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem (required): Registro de Origem

... location 0..1 Reference(Location) Indicação do país de origem do registro da vacina
.... 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 Logical reference, when literal reference is not known
..... 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 País de origem do registro da vacina
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRPais
..... value Σ 1..1 string País de origem do registro da vacina
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0 (required): Códigos para representação de países


Example General: 123456
... manufacturer S 0..1 Reference(Organization) Fabricante
.... 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 SΣ 1..1 Identifier Logical reference, when literal reference is not known
..... 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 SΣ 1..1 uri Fabricante PNI
Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI
..... value SΣ 1..1 string Fabricante do imunobiológico.
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico.


Example General: 123456
... lotNumber S 0..1 string Lote
... expirationDate 0..1 date Data de expiração do imunobiológico
... site S 1..1 CodeableConcept Local de Aplicação
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0 (required): Local de Aplicaçã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
.... coding Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... route S 1..1 CodeableConcept Via de Administração
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0 (required): Via de Administraçã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
.... coding Σ 1..1 Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
... performer SΣ 1..1 BackboneElement Profissional Executante
.... 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
.... actor SΣ 1..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) Identificador do profissional
..... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... reasonReference 0..1 Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0) Motivo de Indicação
... protocolApplied S 1..1 BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
..... extension:strategy S 1..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0]] Extension
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0
..... extension:pesquisaClinica 0..1 ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0]] Pesquisa Clínica
URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..3 Extension Extension
Slice: Unordered, Open by value:url
....... extension:numeroProtocoloEstudoANVISA 0..* Extension ANVISA Protocolo Estudo
....... extension:numeroVersaoProtocoloEstudo 0..* Extension ANVISA Protocolo Versão
....... extension:numeroRegistroVacinaAnvisa 0..* Extension ANVISA Num Registro
...... url 1..1 uri identifies the meaning of the extension
...... value[x] 0..1 Value of extension
....... valueBase64Binary base64Binary
....... valueBoolean boolean
....... valueCanonical canonical(Any)
....... valueCode code
....... valueDate date
....... valueDateTime dateTime
....... valueDecimal decimal
....... valueId id
....... valueInstant instant
....... valueInteger integer
....... valueMarkdown markdown
....... valueOid oid
....... valuePositiveInt positiveInt
....... valueString string
....... valueTime time
....... valueUnsignedInt unsignedInt
....... valueUri uri
....... valueUrl url
....... valueUuid uuid
....... valueAddress Address
....... valueAge Age
....... valueAnnotation Annotation
....... valueAttachment Attachment
....... valueCodeableConcept CodeableConcept
....... valueCoding Coding
....... valueContactPoint ContactPoint
....... valueCount Count
....... valueDistance Distance
....... valueDuration Duration
....... valueHumanName HumanName
....... valueIdentifier Identifier
....... valueMoney Money
....... valuePeriod Period
....... valueQuantity Quantity
....... valueRange Range
....... valueRatio Ratio
....... valueReference Reference(Any)
....... valueSampledData SampledData
....... valueSignature Signature
....... valueTiming Timing
....... valueContactDetail ContactDetail
....... valueContributor Contributor
....... valueDataRequirement DataRequirement
....... valueExpression Expression
....... valueParameterDefinition ParameterDefinition
....... valueRelatedArtifact RelatedArtifact
....... valueTriggerDefinition TriggerDefinition
....... valueUsageContext UsageContext
....... valueDosage Dosage
....... valueMeta Meta
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] S 1..1 string Dose
Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredFixed Value: completed
http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0
Immunization.vaccineCoderequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.reportOriginrequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
http://www.saude.gov.br/fhir/r4/ValueSet/BRRegistroOrigem
Immunization.location.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRPais-1.0
Immunization.manufacturer.identifier.valuerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0
Immunization.siterequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRLocalAplicacao-1.0
Immunization.routerequiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRViaAdministracao-1.0
Immunization.protocolApplied.doseNumber[x]requiredhttp://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0
http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Mandatory: 18 elements(11 nested mandatory elements)
Must-Support: 17 elements
Fixed: 3 elements
Prohibited: 60 elements

Structures

This structure refers to these other structures:

  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0 (no profile found)
  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0 (no profile found)
  • Unable to summarise profile http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCID10Avaliado-1.0 (no profile found)

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BRContatoHanseniase (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacao-1.0 (no extension found)
  • Unable to summarise extension http://www.saude.gov.br/fhir/r4/StructureDefinition/BREstrategiaVacinacaoPesquisa-1.0 (no extension found)

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron