Guia de implementação do Core do Brasil: Release 1 - BR Realm | STU1
1.0.0 - STU1 BR

Publish Box vai aqui

Resource Profile: BRCoreImmunization

URL Canônica: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-immunization Versão: 1.0.0
Active as of 2026-01-14 Nome computável: BRCoreImmunization

Este perfil restringe o recurso Immunization que descreve o evento em que um paciente recebe uma vacina ou um registro de uma imunização conforme relatado por um paciente, um médico ou outra parte

Escopo/Uso

O br-core-immunization tem como objetivo cobrir o registro da administração atual e histórica de vacinas a pacientes em todas as disciplinas de assistência médica em todos os ambientes de atendimento e todas as regiões. Isso inclui a imunização de humanos e animais, mas não inclui a administração de agentes não vacinais, mesmo aqueles que podem ter ou alegam ter efeitos imunológicos. Embora os termos “imunização” e “vacinação” não sejam clinicamente idênticos, para os propósitos dos recursos do FHIR, os termos são usados como sinônimos.

Além disso, espera-se que o recurso Immunization cubra conceitos-chave relacionados à criação, revisão e consulta do histórico de imunização de um paciente. Acredita-se que este recurso, por meio de consulta ao grupo de trabalho de Saúde Pública, atenda aos principais casos de uso e requisitos de informação, conforme definido no guia de implementação de imunização HL7 V2, HL7 V3 e Modelo de Análise de Domínio de Imunização.

Caso de uso da RNDS

​Na RNDS alguns elementos do br-core-immunization são considerados obrigatórios por conta das resoluções relacionadas ao Programa Nacional de Imunizações – PNI conforme pode ser consultado no manual de normas e procedimentos.

Os registros de imunização estão registrados por duas compositions na RNDS: o ImmunizationAdministrado na rotina e o ImmunizationAdministradoCampanha, utilizando o BRImunobiológicoAdministrado.

MUST SUPPORT - Elementos de dados obrigatórios e que devem estar presentes

Os seguintes elementos devem ser obrigatórios, ou devem ser suportados, se os dados estiverem presentes no sistema de envio (definição Must Support). Os elementos definidos como Must Support consideram a legislação do PNI.

Cada Perfil Immunization deve ter:

  1. Status
  2. vaccineCode
  3. patient
  4. occurrence
  5. doseNumber

Seguindo a legislação do PNI, cada Perfil Immunization deve oferecer suporte a:

  1. status
  2. vaccineCode
  3. patient
  4. occurrence
  5. manufacturer
  6. manufacturer.identifier
  7. manufacturer.system
  8. manufacturer.value
  9. lotNumber
  10. site.coding

Orientações de implementação específicas do perfil

O perfil br-core-immunization não deve ser utilizado para o registro de administração de imunobiológicos não relacionados à imunização, ou seja, que não são vacinas. Os imunobiológicos não imunizantes incluem produtos biológicos que não são administrados com o objetivo de proporcionar imunidade a uma doença específica, mas podem ter outras finalidades terapêuticas ou médicas, como a administração de soros. Estes são produtos imunobiológicos que contêm anticorpos específicos para neutralizar toxinas ou agentes infecciosos e são utilizados no tratamento de envenenamentos por picadas de animais peçonhentos ou em algumas infecções. Esse recurso também não deve ser utilizado no caso de administração de imunoglobulinas, que são imunoglobulinas utilizadas para tratar algumas infecções virais. O registro da administração desses imunobiológicos deve ser realizado no recurso MedicationAdministration.

É importante distinguir entre imunobiológicos imunizantes (vacinas) e imunobiológicos não imunizantes, uma vez que têm finalidades e características diferentes. O registro e a documentação adequada desses produtos e tratamentos são essenciais para garantir a segurança e eficácia do tratamento do paciente.

Limites e relacionamentos

A administração de vacinas deve ser manipulada usando o recurso Immunization. O recurso MedicationAdministration deve rastrear a administração de medicamentos não vacinais. Alguns sistemas tratam imunizações da mesma forma que qualquer outra administração de medicamentos. Esses sistemas devem usar um recurso de imunização para representá-los. Se os sistemas precisarem usar um recurso MedicationAdministration para capturar vacinações para fluxo de trabalho ou outros motivos, eles DEVEM também expor uma instância de Immunization equivalente Immunization.reaction pode ser uma indicação de alergia ou intolerância. Se esse caso for considerado, uma instância de recurso AllergyIntolerance separada deve ser criada para indicá-lo, pois a maioria dos sistemas não consultará o dado Immunization.reaction anterior.

Este recurso é referenciado por AdverseEvent, ChargeItem, ImmunizationEvaluation, ImmunizationRecommendation e Observation.

Usos:

Visões formais do conteúdo do perfil

Descrição de perfis, diferenciais, instantâneos e como as diferentes apresentações funcionam.

Esta estrutura é derivada de Immunization

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization Immunization
... id 0..1 id Identificador lógico deste artefato
... meta 0..1 Meta Metadados sobre o recurso
... implicitRules 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... language 0..1 code Idioma do recurso
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status 1..1 code O status do evento de administração de imunobiológico
... statusReason 0..0
... vaccineCode 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... reference 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type 0..1 uri O tipo de referência utilizada
.... identifier 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display 0..1 string Texto alternativo para o recurso
... encounter 0..0
... occurrence[x] 1..1 dateTime, string Data em que o imunobiológico foi administrado
... recorded 0..0
... primarySource 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... note 0..0
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... authority 0..0
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 positiveInt, string Número de doses da série do imunobiológico

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG
NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension ?! 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status ?!Σ 1..1 code O status do evento de administração de imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient Σ 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type Σ 0..1 uri O tipo de referência utilizada
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display Σ 0..1 string Texto alternativo para o recurso
... occurrence[x] Σ 1..1 Data em que o imunobiológico foi administrado
.... occurrenceDateTime dateTime
.... occurrenceString string
... primarySource Σ 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer Σ 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function Σ 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor Σ 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 Número de doses da série do imunobiológico
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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()
NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension ?! 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status ?!Σ 1..1 code O status do evento de administração de imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient Σ 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type Σ 0..1 uri O tipo de referência utilizada
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display Σ 0..1 string Texto alternativo para o recurso
... occurrence[x] Σ 1..1 Data em que o imunobiológico foi administrado
.... occurrenceDateTime dateTime
.... occurrenceString string
... primarySource Σ 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer Σ 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function Σ 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor Σ 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 Número de doses da série do imunobiológico
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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()

Visão diferencial

Esta estrutura é derivada de Immunization

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization Immunization
... id 0..1 id Identificador lógico deste artefato
... meta 0..1 Meta Metadados sobre o recurso
... implicitRules 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... language 0..1 code Idioma do recurso
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status 1..1 code O status do evento de administração de imunobiológico
... statusReason 0..0
... vaccineCode 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... reference 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type 0..1 uri O tipo de referência utilizada
.... identifier 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display 0..1 string Texto alternativo para o recurso
... encounter 0..0
... occurrence[x] 1..1 dateTime, string Data em que o imunobiológico foi administrado
... recorded 0..0
... primarySource 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... note 0..0
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... authority 0..0
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 positiveInt, string Número de doses da série do imunobiológico

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG

Visualização de elementos -chave

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension ?! 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status ?!Σ 1..1 code O status do evento de administração de imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient Σ 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type Σ 0..1 uri O tipo de referência utilizada
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display Σ 0..1 string Texto alternativo para o recurso
... occurrence[x] Σ 1..1 Data em que o imunobiológico foi administrado
.... occurrenceDateTime dateTime
.... occurrenceString string
... primarySource Σ 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer Σ 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function Σ 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor Σ 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 Número de doses da série do imunobiológico
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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()

Visualização instantânea

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Um conjunto de regras sob as quais este conteúdo foi criado
... text 0..1 Narrative Resumo do texto do recurso em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos contidos no recurso
... extension 0..* Extension Extensões adicionais que não fazem parte do modelo base
... modifierExtension ?! 0..* Extension Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
... identifier 0..* Identifier Identificadores externos para este recurso
... status ?!Σ 1..1 code O status do evento de administração de imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado
Vínculo: BR Imunobiologico (required)
... patient Σ 1..1 Reference(BRCorePatient) O paciente que recebeu o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 0..1 string Referência literal,relativa, interna ou externa ou URL
.... type Σ 0..1 uri O tipo de referência utilizada
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Referência lógica,quando a referência literal não é conhecida
.... display Σ 0..1 string Texto alternativo para o recurso
... occurrence[x] Σ 1..1 Data em que o imunobiológico foi administrado
.... occurrenceDateTime dateTime
.... occurrenceString string
... primarySource Σ 0..1 boolean Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde
... reportOrigin 0..1 CodeableConcept Indica a fonte do registro de vacinação relatado
Vínculo: BR Registro Origem (required)
... location 0..1 Reference(br-core-location) Local onde o imunobiológico foi administrado
... manufacturer 0..1 Reference(BRCoreOrganization) Fabricante do imunobiológico
... lotNumber 0..1 string Número do lote do imunobiológico
... expirationDate 0..1 date Data de validade do imunobiológico
... site 1..1 CodeableConcept Local de administração do imunobiológico
Vínculo: BR Local Aplicacao (required)
... route 1..1 CodeableConcept Via de administração do imunobiológico
Vínculo: BR Via Administracao (required)
... doseQuantity 0..1 SimpleQuantity Quantidade de imunobiológico administrado
... performer Σ 1..1 BackboneElement Profissional de saúde que administrou o imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... function Σ 1..1 CodeableConcept Função do profissional de saúde no evento de administração de imunobiológico
Vínculo: BR Ocupacao (required)
.... actor Σ 1..1 Reference(BRCorePractitioner | BRCorePractitionerRole | BRCoreOrganization) Profissional de saúde que administrou o imunobiológico
... reasonCode 0..1 CodeableConcept Motivo pelo qual o imunobiológico foi administrado
Vínculo: BR Estrategia Vacinacao (required)
... reasonReference 0..1 Reference(BRCoreCondition | BRCoreObservation | BRCoreDiagnosticReport) Referência ao motivo pelo qual o imunobiológico foi administrado
... protocolApplied 1..1 BackboneElement Protocolos aplicados durante a administração do imunobiológico
.... id 0..1 string Identificador único para referência cruzada
.... Fatias para extension 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
Fatia: Não ordenado, Aberto por value:url
..... extension:pesquisaClinica 0..1 (Complexo) Pesquisa clínica
URL: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-pesquisaclinica
.... modifierExtension ?!Σ 0..* Extension Extensões adicionais que não fazem parte do modelo de dados básico
.... series 0..1 string Nome da série do imunobiológico
.... targetDisease 0..* CodeableConcept Doença alvo do imunobiológico
Vínculo: BRCID 10 (preferred)
.... doseNumber[x] 1..1 string Número da dose do imunobiológico
Vínculo: BR Dose (required)
.... seriesDoses[x] 0..1 Número de doses da série do imunobiológico
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredBRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
From este IG
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginrequiredBRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
From este IG
Immunization.siterequiredBRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
From este IG
Immunization.routerequiredBRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
From este IG
Immunization.performer.functionrequiredBROcupacao
https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao
From este IG
Immunization.reasonCoderequiredBREstrategiaVacinacao
https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao
From este IG
Immunization.protocolApplied.targetDiseasepreferredBRCID10
https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10
From este IG
Immunization.protocolApplied.doseNumber[x]requiredBRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
From este IG

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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()

 

Outras representações de perfil: CSV, Excel, Schematron