Este perfil representa as restrições aplicadas ao recurso de Immunization pelo Guia de Implementação FHIR do Resumo Internacional de Pacientes (IPS). Um registro de uma imunização é representado no Sumário do Paciente como uma instância de um recurso de Imunização restrito por esse perfil.

Descreve todos os eventos de imunobiológicos administrados, sejam em campanha ou rotina do paciente, enviados para a Rede Nacional de Dados em Saúde (RNDS).

Escopo/Uso

Descreve o evento em que um paciente recebeu uma vacinação ou um registro de vacinação conforme relatado por um paciente, um médico ou terceiros. Este recurso é usado para manter os dados de imunização do paciente, os dados sobre vacina, considerando todos os cenários de aplicação, tendo como público-alvo os estabelecimentos de saúde que administram os imunobiológicos. Vale ressaltar que a RNDS (Rede Nacional de Dados em Saúde) diferencia Registro de Imunobiológico Administrado em Rotina e Registro de Imunobiológico Administrado em Campanha. Os dados destes perfis serão enviados no perfil de Immunization do BRIPS.

O recurso Vacinação destina-se a cobrir o registro da administração atual e histórica de vacinas a pacientes em todas as disciplinas de cuidados de saúde, em todos os ambientes de cuidados e em todas as regiões. Isto inclui a imunização de humanos e animais, mas não inclui a administração de agentes não vacinais, mesmo aqueles que possam ter ou alegar ter efeitos imunológicos. Embora os termos “imunização” e “vacinação” não sejam clinicamente idênticos, para efeitos dos recursos do FHIR, os termos são utilizados como sinônimos.

Além disso, espera-se que o recurso Imunização cubra conceitos-chave relacionados à criação, revisão e consulta do histórico de imunização de um paciente. Acredita-se que este recurso - através de consulta com o 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 (http://www.hl7.org/implement/standards/product_brief.cfm?product_id=185) e Hl7 v3 (https://www.hl7.org/implement/standards/product_brief.cfm?product_id=186)

Uso indevido

Esse recurso 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.

Caso de uso

Exibe todas as informações sobre a seção de imunização do paciente. Neste cenário, o paciente poderá acessar um aplicativo (Meu SUS Digital ou outro APP exemplo) e ter a opção Gerar Sumário Internacional do Paciente, visualizando todas as informações que estão na RNDS referentes aos imunobiológicos administrados.

Identificadores

O imunobiológico administrado deve possuir obrigatoriamente um identificador que é o código da vacina (vaccineCode), o paciente que recebeu a aplicação (Reference (PatientBRIPS)) e a data da ocorrência da vacina (occurenceDateTime). Para a construção do IPS Brasil foi feito o mapeamento conceitual entre os elementos do CodeSystem BRImunobiológico para o elenco do valueset Vaccines - SNOMED CT IPS Free Set. A metodologia para realização dos mapeamentos obedeceu a norma ABNT NBR ISO 12300: Informática em Saúde – Princípios de Mapeamento entre Sistemas Terminológicos, respeitando os princípios de grau de equivalência e cardinalidade para cada mapeamento. O Codesystem – BRImunobiologico (https://simplifier.net/redenacionaldedadosemsaude/structuredefinition-brimunobiologicoadministrado-3.0) contém 111 conceitos: 80 vacinas, 15 antitoxinas ou soros, 4 imunoglobulinas e 12 diluentes. Das 80 vacinas, quatro não estão mais ativas. A seção de imunização deve conter apenas as vacinas aplicadas e não os soros ou imunoglobulinas. Apesar disto, os 99 imunobiológicos (os 12 diluentes não foram considerados) foram mapeados para o SNOMED-IPS, considerando que os soros e imunoglobulinas serão informados na seção de Medications do Sumário Internacional do Paciente.

A Tabela 1 apresenta os graus de equivalência dos mapeamento das 80 vacinas para o SNOMED-IPS.

Tabela 1: Relação entre os graus de equivalência e os códigos de vacinas mapeados.

Os soros e imunoglobulinas não pertencem a esse caso de uso, posto que não são vacinas, assim sendo devem ser informados no MedicationAdministration.

Extensões

Este perfil não possui extensões.

Limites e Relacionamentos

A administração de vacinas deve ser feita utilizando o recurso Imunização. MedicationAdministration destina-se a rastrear a administração de medicamentos não vacinais. Alguns sistemas tratam as imunizações da mesma forma que qualquer outra administração de medicamentos. Tais sistemas DEVEM utilizar um recurso de imunização para representá-los. Se os sistemas precisarem usar um recurso MedicationAdministration para capturar vacinações por fluxo de trabalho ou outros motivos, eles também DEVEM expor uma instância de imunização equivalente.

O recurso Imunobiológico Administrado, no caso o perfil ImmunizationBRIPS, pode ser referenciado por outros recursos para determinadas ações. Por exemplo, este perfil faz referência ao Paciente que recebeu o imunobiológico (Reference (PatientBRIPS)) e ao perfil Organization que indica o estabelecimento de saúde que executou a vacina.

A reação de imunização pode ser uma indicação de alergia ou intolerância. Se este for considerado o caso, uma instância separada do recurso AllergyIntolerance deverá ser criada para indicá-lo, já que a maioria dos sistemas não consultará Immunization.reaction passado.

Mapeamento de estrutura

Mapeamento de estrutura BRImunobiologicoAdministradoCampanha-1.0 RNDS para ImmunizationBRIPS.

Mapeamento de estrutura BRImunobiologicoAdministradoCampanha-2.0 RNDS para ImmunizationBRIPS do IPS.

Incluído nesse perfil as extensões Grupo de Atendimento que um elemento codificável como o ValueSet BRGrupoAtendimento e a extensão Condição maternal BRCondicaoMaternal que tem um binding para o ValueSet Cndição Maternal, que não serão mapeados para o IPS Brasil

Mapeamento de estrutura BRImunobiologicoAdministrado-2.0 para ImmunizationBRIPS do IPS.

Mapeamento de estrutura BRImunobiologicoAdministrado-02.11 RNDS para ImmunizationBRIPS do IPS.

Incluído nessa versão o elemento codificável opcional reportOrigin, com binding para o ValueSet BRRegistroOrigem.

• Tabela diferencial
• Tabela de elementos -chave
• Tabela de instantâneos
• Estatísticas/Referências
• Todos

Esta estrutura é derivada de ImmunizationUvIps

Name	Flags	Card.	Type	Description & Constraints
Immunization			ImmunizationUvIps
id		0..1	id	ID lógico deste artefato
meta		0..1	Meta	Metadados sobre o recurso
implicitRules		0..1	uri	Regras implícitas de rastreamento
language		0..1	code	Idioma do recurso
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso
contained		0..*	Resource	Recursos contidos no artefato
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
identifier		0..*	Identifier	Identificadores externos para este recurso
status		1..1	code	O status do evento de administração de imunobiológico
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado
vaccineCode		1..1	CodeableConceptIPS	Imunobiológico administrado
patient		1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico
reference		1..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..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado
occurrence[x]		1..1	dateTime, string	Data em que o imunobiológico foi administrado
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito
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
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado
manufacturer		0..1	Reference(OrganizationBRIPS)	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		0..1	CodeableConceptIPS	Local de administração do imunobiológico
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado
performer		0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico
id		0..1	string	Identificador único para referenciação 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		0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico
actor		1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico
note		0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado
isSubpotent		0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada
education		0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico
id		0..1	string	Identificador único para referenciação 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
documentType		0..1	string	Tipo de documento educacional
reference		0..1	uri	Referência ao documento educacional
publicationDate		0..1	dateTime	Data de publicação do documento educacional
presentationDate		0..1	dateTime	Data de apresentação do documento educacional
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico
id		0..1	string	Identificador único para referenciação 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
date		0..1	dateTime	Data em que a reação adversa ocorreu
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico
id		0..1	string	Identificador único para referenciação 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
series		0..1	string	Nome da série do imunobiológico
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico
doseNumber[x]		1..1	positiveInt, string	Número da dose do imunobiológico
seriesDoses[x]		0..1	positiveInt, string	Número de doses da série do imunobiológico
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationUvIps	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	0..1	id	ID lógico deste artefato
meta	Σ	0..1	Meta	Metadados sobre o recurso ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	Regras implícitas de rastreamento ele-1: All FHIR elements must have a @value or children
language		0..1	code	Idioma do recurso Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Recursos contidos no artefato
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		0..*	Identifier	Identificadores externos para este recurso ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	O status do evento de administração de imunobiológico Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. ele-1: All FHIR elements must have a @value or children
vaccineCode	S	1..1	CodeableConceptIPS	Imunobiológico administrado Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
reference	SΣC	1..1	string	Referência literal,relativa, interna ou externa ou URL ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	uri	O tipo de referência utilizada Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children
identifier	Σ	0..1	Identifier	Referência lógica,quando a referência literal não é conhecida ele-1: All FHIR elements must have a @value or children
display	Σ	0..1	string	Texto alternativo para o recurso ele-1: All FHIR elements must have a @value or children
encounter		0..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
occurrence[x]	SΣ	1..1		Data em que o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
occurrence[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito ele-1: All FHIR elements must have a @value or children
primarySource	Σ	0..1	boolean	Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde ele-1: All FHIR elements must have a @value or children
reportOrigin		0..1	CodeableConcept	Indica a fonte do registro de vacinação relatado Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. ele-1: All FHIR elements must have a @value or children
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
manufacturer		0..1	Reference(OrganizationBRIPS)	Fabricante do imunobiológico ele-1: All FHIR elements must have a @value or children
lotNumber		0..1	string	Número do lote do imunobiológico ele-1: All FHIR elements must have a @value or children
expirationDate		0..1	date	Data de validade do imunobiológico ele-1: All FHIR elements must have a @value or children
site		0..1	CodeableConceptIPS	Local de administração do imunobiológico Binding: SNOMEDCTBodyStructures (preferred) ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico Binding: Medicine Route of Administration - IPS (preferred) ele-1: All FHIR elements must have a @value or children
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado ele-1: All FHIR elements must have a @value or children
performer	Σ	0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children
actor	Σ	1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico ele-1: All FHIR elements must have a @value or children
note	Σ	0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico ele-1: All FHIR elements must have a @value or children
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada ele-1: All FHIR elements must have a @value or children
education	C	0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
documentType		0..1	string	Tipo de documento educacional ele-1: All FHIR elements must have a @value or children
reference		0..1	uri	Referência ao documento educacional ele-1: All FHIR elements must have a @value or children
publicationDate		0..1	dateTime	Data de publicação do documento educacional ele-1: All FHIR elements must have a @value or children
presentationDate		0..1	dateTime	Data de apresentação do documento educacional ele-1: All FHIR elements must have a @value or children
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. ele-1: All FHIR elements must have a @value or children
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
date		0..1	dateTime	Data em que a reação adversa ocorreu ele-1: All FHIR elements must have a @value or children
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa ele-1: All FHIR elements must have a @value or children
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente ele-1: All FHIR elements must have a @value or children
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
series		0..1	string	Nome da série do imunobiológico ele-1: All FHIR elements must have a @value or children
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo ele-1: All FHIR elements must have a @value or children
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate ele-1: All FHIR elements must have a @value or children
doseNumber[x]		1..1		Número da dose do imunobiológico ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Número de doses da série do imunobiológico ele-1: All FHIR elements must have a @value or children
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationUvIps	Immunization event information
id	Σ	0..1	id	ID lógico deste artefato
meta	Σ	0..1	Meta	Metadados sobre o recurso
implicitRules	?!Σ	0..1	uri	Regras implícitas de rastreamento
language		0..1	code	Idioma do recurso Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso
contained		0..*	Resource	Recursos contidos no artefato
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
identifier		0..*	Identifier	Identificadores externos para este recurso
status	?!SΣ	1..1	code	O status do evento de administração de imunobiológico Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	S	1..1	CodeableConceptIPS	Imunobiológico administrado Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Referência literal,relativa, interna ou externa ou URL
type	Σ	0..1	uri	O tipo de referência utilizada Binding: 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
encounter		0..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado
occurrence[x]	SΣ	1..1		Data em que o imunobiológico foi administrado
occurrence[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito
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 Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado
manufacturer		0..1	Reference(OrganizationBRIPS)	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		0..1	CodeableConceptIPS	Local de administração do imunobiológico Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico Binding: Medicine Route of Administration - IPS (preferred)
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado
performer	Σ	0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico
id		0..1	string	Identificador único para referenciação 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	Σ	0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico
note	Σ	0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado
isSubpotent	?!Σ	0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico imm-1: One of documentType or reference SHALL be present
id		0..1	string	Identificador único para referenciação 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
documentType		0..1	string	Tipo de documento educacional
reference		0..1	uri	Referência ao documento educacional
publicationDate		0..1	dateTime	Data de publicação do documento educacional
presentationDate		0..1	dateTime	Data de apresentação do documento educacional
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico
id		0..1	string	Identificador único para referenciação 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
date		0..1	dateTime	Data em que a reação adversa ocorreu
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico
id		0..1	string	Identificador único para referenciação 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
series		0..1	string	Nome da série do imunobiológico
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]		1..1		Número da dose do imunobiológico
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Número de doses da série do imunobiológico
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Visão diferencial

Esta estrutura é derivada de ImmunizationUvIps

Name	Flags	Card.	Type	Description & Constraints
Immunization			ImmunizationUvIps
id		0..1	id	ID lógico deste artefato
meta		0..1	Meta	Metadados sobre o recurso
implicitRules		0..1	uri	Regras implícitas de rastreamento
language		0..1	code	Idioma do recurso
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso
contained		0..*	Resource	Recursos contidos no artefato
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
identifier		0..*	Identifier	Identificadores externos para este recurso
status		1..1	code	O status do evento de administração de imunobiológico
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado
vaccineCode		1..1	CodeableConceptIPS	Imunobiológico administrado
patient		1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico
reference		1..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..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado
occurrence[x]		1..1	dateTime, string	Data em que o imunobiológico foi administrado
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito
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
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado
manufacturer		0..1	Reference(OrganizationBRIPS)	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		0..1	CodeableConceptIPS	Local de administração do imunobiológico
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado
performer		0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico
id		0..1	string	Identificador único para referenciação 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		0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico
actor		1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico
note		0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado
isSubpotent		0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada
education		0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico
id		0..1	string	Identificador único para referenciação 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
documentType		0..1	string	Tipo de documento educacional
reference		0..1	uri	Referência ao documento educacional
publicationDate		0..1	dateTime	Data de publicação do documento educacional
presentationDate		0..1	dateTime	Data de apresentação do documento educacional
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico
id		0..1	string	Identificador único para referenciação 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
date		0..1	dateTime	Data em que a reação adversa ocorreu
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico
id		0..1	string	Identificador único para referenciação 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
series		0..1	string	Nome da série do imunobiológico
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico
doseNumber[x]		1..1	positiveInt, string	Número da dose do imunobiológico
seriesDoses[x]		0..1	positiveInt, string	Número de doses da série do imunobiológico
Documentation for this format

Visualização de elementos -chave

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationUvIps	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	0..1	id	ID lógico deste artefato
meta	Σ	0..1	Meta	Metadados sobre o recurso ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	Regras implícitas de rastreamento ele-1: All FHIR elements must have a @value or children
language		0..1	code	Idioma do recurso Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Recursos contidos no artefato
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		0..*	Identifier	Identificadores externos para este recurso ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	O status do evento de administração de imunobiológico Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. ele-1: All FHIR elements must have a @value or children
vaccineCode	S	1..1	CodeableConceptIPS	Imunobiológico administrado Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
reference	SΣC	1..1	string	Referência literal,relativa, interna ou externa ou URL ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	uri	O tipo de referência utilizada Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children
identifier	Σ	0..1	Identifier	Referência lógica,quando a referência literal não é conhecida ele-1: All FHIR elements must have a @value or children
display	Σ	0..1	string	Texto alternativo para o recurso ele-1: All FHIR elements must have a @value or children
encounter		0..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
occurrence[x]	SΣ	1..1		Data em que o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
occurrence[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito ele-1: All FHIR elements must have a @value or children
primarySource	Σ	0..1	boolean	Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde ele-1: All FHIR elements must have a @value or children
reportOrigin		0..1	CodeableConcept	Indica a fonte do registro de vacinação relatado Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. ele-1: All FHIR elements must have a @value or children
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
manufacturer		0..1	Reference(OrganizationBRIPS)	Fabricante do imunobiológico ele-1: All FHIR elements must have a @value or children
lotNumber		0..1	string	Número do lote do imunobiológico ele-1: All FHIR elements must have a @value or children
expirationDate		0..1	date	Data de validade do imunobiológico ele-1: All FHIR elements must have a @value or children
site		0..1	CodeableConceptIPS	Local de administração do imunobiológico Binding: SNOMEDCTBodyStructures (preferred) ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico Binding: Medicine Route of Administration - IPS (preferred) ele-1: All FHIR elements must have a @value or children
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado ele-1: All FHIR elements must have a @value or children
performer	Σ	0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children
actor	Σ	1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico ele-1: All FHIR elements must have a @value or children
note	Σ	0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico ele-1: All FHIR elements must have a @value or children
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada ele-1: All FHIR elements must have a @value or children
education	C	0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
documentType		0..1	string	Tipo de documento educacional ele-1: All FHIR elements must have a @value or children
reference		0..1	uri	Referência ao documento educacional ele-1: All FHIR elements must have a @value or children
publicationDate		0..1	dateTime	Data de publicação do documento educacional ele-1: All FHIR elements must have a @value or children
presentationDate		0..1	dateTime	Data de apresentação do documento educacional ele-1: All FHIR elements must have a @value or children
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. ele-1: All FHIR elements must have a @value or children
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
date		0..1	dateTime	Data em que a reação adversa ocorreu ele-1: All FHIR elements must have a @value or children
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa ele-1: All FHIR elements must have a @value or children
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente ele-1: All FHIR elements must have a @value or children
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico ele-1: All FHIR elements must have a @value or children
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
series		0..1	string	Nome da série do imunobiológico ele-1: All FHIR elements must have a @value or children
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo ele-1: All FHIR elements must have a @value or children
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate ele-1: All FHIR elements must have a @value or children
doseNumber[x]		1..1		Número da dose do imunobiológico ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Número de doses da série do imunobiológico ele-1: All FHIR elements must have a @value or children
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Visualização instantânea

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationUvIps	Immunization event information
id	Σ	0..1	id	ID lógico deste artefato
meta	Σ	0..1	Meta	Metadados sobre o recurso
implicitRules	?!Σ	0..1	uri	Regras implícitas de rastreamento
language		0..1	code	Idioma do recurso Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Texto narrativo, resumo, instruções ou legenda sobre o recurso
contained		0..*	Resource	Recursos contidos no artefato
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
identifier		0..*	Identifier	Identificadores externos para este recurso
status	?!SΣ	1..1	code	O status do evento de administração de imunobiológico Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	O motivo pelo qual o imunobiológico não foi administrado Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	S	1..1	CodeableConceptIPS	Imunobiológico administrado Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(PatientBRIPS)	O paciente que recebeu o imunobiológico
id		0..1	string	Identificador único para referenciação cruzada
extension		0..*	Extension	Extensões adicionais que não fazem parte do modelo de dados básico Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Referência literal,relativa, interna ou externa ou URL
type	Σ	0..1	uri	O tipo de referência utilizada Binding: 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
encounter		0..1	Reference(Encounter)	Referência ao atendimento no qual o imunobiológico foi administrado
occurrence[x]	SΣ	1..1		Data em que o imunobiológico foi administrado
occurrence[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	Data em que o primeiro registro de vacinação foi feito
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 Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Local onde o imunobiológico foi administrado
manufacturer		0..1	Reference(OrganizationBRIPS)	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		0..1	CodeableConceptIPS	Local de administração do imunobiológico Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Via de administração do imunobiológico Binding: Medicine Route of Administration - IPS (preferred)
doseQuantity		0..1	SimpleQuantity	Quantidade de imunobiológico administrado
performer	Σ	0..*	BackboneElement	Profissional de saúde que administrou o imunobiológico
id		0..1	string	Identificador único para referenciação 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	Σ	0..1	CodeableConcept	Função do profissional de saúde no evento de administração de imunobiológico Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(PractitionerBRIPS | PractitionerRoleBRIPS | OrganizationBRIPS)	Profissional de saúde que administrou o imunobiológico
note	Σ	0..*	Annotation	Observações adicionais sobre o evento de administração de imunobiológico
reasonCode		0..*	CodeableConcept	Motivo pelo qual o imunobiológico foi administrado Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(ConditionBRIPS | DiagnosticReportBRIPS | Observation)	Referência ao motivo pelo qual o imunobiológico foi administrado
isSubpotent	?!Σ	0..1	boolean	Indica se o imunobiológico foi administrado em uma dose menor que a recomendada
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Informações sobre a educação do paciente sobre o imunobiológico imm-1: One of documentType or reference SHALL be present
id		0..1	string	Identificador único para referenciação 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
documentType		0..1	string	Tipo de documento educacional
reference		0..1	uri	Referência ao documento educacional
publicationDate		0..1	dateTime	Data de publicação do documento educacional
presentationDate		0..1	dateTime	Data de apresentação do documento educacional
programEligibility		0..*	CodeableConcept	Informações sobre a elegibilidade do paciente para o programa de imunização Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Fonte de financiamento do imunobiológico Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Reações adversas do paciente ao imunobiológico
id		0..1	string	Identificador único para referenciação 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
date		0..1	dateTime	Data em que a reação adversa ocorreu
detail		0..1	Reference(Observation)	Detalhes sobre a reação adversa
reported		0..1	boolean	Indica que a reação adversa foi relatada pelo paciente
protocolApplied		0..*	BackboneElement	Protocolos aplicados durante a administração do imunobiológico
id		0..1	string	Identificador único para referenciação 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
series		0..1	string	Nome da série do imunobiológico
authority		0..1	Reference(OrganizationBRIPS)	Autoridade que definiu o protocolo
targetDisease		0..*	CodeableConcept	Doença alvo do imunobiológico Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]		1..1		Número da dose do imunobiológico
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Número de doses da série do imunobiológico
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Esta estrutura é derivada de ImmunizationUvIps

Summary

Structures

This structure refers to these other structures:

• PatientBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/PatientBRIPS)
• OrganizationBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/OrganizationBRIPS)
• PractitionerBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/PractitionerBRIPS)
• PractitionerRoleBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/PractitionerRoleBRIPS)
• ConditionBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/ConditionBRIPS)
• DiagnosticReportBRIPS (https://ips.saude.gov.br/fhir/StructureDefinition/DiagnosticReportBRIPS)