Guia de Implementação da SES GO - Imunização
1.0.0 - draft BR

Guia de Implementação da SES GO - Imunização - Downloaded Version 1.0.0 See the Directory of published versions

Perfil: Administração de Imunobiológicos

URL oficial: https://fhir.saude.go.gov.br/r4/imunizacao/StructureDefinition/imunobiologico-administrado Versão: 1.0.0
Draft as of 2025-12-12 Domínio: Brazil flag Nome para computador: ImunobiologicoAdministrado

Perfil para representar um imunobiológico administrado.

Usos:

  • Este Perfil não é utilizado por nenhum perfil neste guia de implementação

You can also check for usages in the FHIR IG Statistics

Representações do perfil

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

Essa estrutura é derivada de Immunization

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... status 1..1 code Status da administração do imunobiológico
Padrão necessário: completed
... vaccineCode 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... patient 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Fatias para occurrence[x] 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Aberto por type:$this
.... occurrence[x]:occurrenceDateTime 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... Fatias para performer 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:estabelecimento 1..1 BackboneElement Who performed event
..... actor 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... performer:profissional 1..1 BackboneElement Who performed event
..... actor 1..1 Reference(Profissional) Profissional de Saúde
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
... protocolApplied
.... series 1..1 string Número da dose no protocolo (considerando a sequência de doses para cada tipo de vacina dentro do protocolo).
.... authority 1..1 Reference(Organization) Indica a autoridade que publicou o protocolo que está sendo seguido.
.... Fatias para doseNumber[x] 1..1 positiveInt, string Dose number within series
Fatia: Não ordenado, Aberto por type:$this
..... doseNumber[x]:doseNumberString 0..1 string Posição nominal em uma série
.... Fatias para seriesDoses[x] 1..1 positiveInt, string Recommended number of doses for immunity
Fatia: Não ordenado, Aberto por type:$this
..... seriesDoses[x]:seriesDosesString 0..1 string Conjunto de recomendações seguido pelo vacinador que administrou a dose

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Status da administração do imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Padrão necessário: completed
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
... patient Σ 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Fatias para occurrence[x] Σ 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Fechado por type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... Fatias para performer Σ 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:estabelecimento Σ 1..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... performer:profissional Σ 1..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Profissional) Profissional de Saúde
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeValueSet / CódigoURI
Immunization.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

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 Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code Status da administração do imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Padrão necessário: completed
... statusReason 0..1 CodeableConcept Reason not done
Vínculo: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Fatias para occurrence[x] Σ 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Fechado por type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... Fatias para performer Σ 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:estabelecimento Σ 1..1 BackboneElement Who performed event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... performer:profissional Σ 1..1 BackboneElement Who performed event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Profissional) Profissional de Saúde
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Vínculo: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Vínculo: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Vínculo: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Vínculo: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... series 1..1 string Número da dose no protocolo (considerando a sequência de doses para cada tipo de vacina dentro do protocolo).
.... authority 1..1 Reference(Organization) Indica a autoridade que publicou o protocolo que está sendo seguido.
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Vínculo: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... Fatias para doseNumber[x] 1..1 Dose number within series
Fatia: Não ordenado, Aberto por type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberString 0..1 string Posição nominal em uma série
.... Fatias para seriesDoses[x] 1..1 Recommended number of doses for immunity
Fatia: Não ordenado, Aberto por type:$this
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
..... seriesDoses[x]:seriesDosesString 0..1 string Conjunto de recomendações seguido pelo vacinador que administrou a dose

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeValueSet / CódigoURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From a norma FHIR
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From a norma FHIR
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From a norma FHIR
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From a norma FHIR
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:estabelecimento.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:estabelecimento.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.performer:profissional.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:profissional.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From a norma FHIR
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From a norma FHIR
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From a norma FHIR
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From a norma FHIR
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From a norma FHIR

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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

Essa estrutura é derivada de Immunization

Resumo

Obrigatório: 7 elementos(5 aninhado obrigatoriamente elementos)

Estruturas

Esta estrutura refere-se a estas outras estruturas:

Fatias

Esta estrutura define os seguintes Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.performer (Closed)
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.seriesDoses[x]

Visão de diferenças

Essa estrutura é derivada de Immunization

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... status 1..1 code Status da administração do imunobiológico
Padrão necessário: completed
... vaccineCode 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... patient 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Fatias para occurrence[x] 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Aberto por type:$this
.... occurrence[x]:occurrenceDateTime 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... Fatias para performer 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:estabelecimento 1..1 BackboneElement Who performed event
..... actor 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... performer:profissional 1..1 BackboneElement Who performed event
..... actor 1..1 Reference(Profissional) Profissional de Saúde
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
... protocolApplied
.... series 1..1 string Número da dose no protocolo (considerando a sequência de doses para cada tipo de vacina dentro do protocolo).
.... authority 1..1 Reference(Organization) Indica a autoridade que publicou o protocolo que está sendo seguido.
.... Fatias para doseNumber[x] 1..1 positiveInt, string Dose number within series
Fatia: Não ordenado, Aberto por type:$this
..... doseNumber[x]:doseNumberString 0..1 string Posição nominal em uma série
.... Fatias para seriesDoses[x] 1..1 positiveInt, string Recommended number of doses for immunity
Fatia: Não ordenado, Aberto por type:$this
..... seriesDoses[x]:seriesDosesString 0..1 string Conjunto de recomendações seguido pelo vacinador que administrou a dose

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

Visão de elementos chave

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Status da administração do imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Padrão necessário: completed
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
... patient Σ 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Fatias para occurrence[x] Σ 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Fechado por type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... Fatias para performer Σ 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:estabelecimento Σ 1..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... performer:profissional Σ 1..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Profissional) Profissional de Saúde
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeValueSet / CódigoURI
Immunization.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

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 instantâneo

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code Status da administração do imunobiológico
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Padrão necessário: completed
... statusReason 0..1 CodeableConcept Reason not done
Vínculo: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Imunobiológico administrado (vacina)
Vínculo: Imunobiológico (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Indivíduo) Cidadão(ã) ao qual o imunobiológico se refere
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Fatias para occurrence[x] Σ 1..1 dateTime Vaccine administration date
Fatia: Não ordenado, Fechado por type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime Data da administração do imunobiológico (vacina)
... recorded 1..1 dateTime Data e hora do registro no sistema
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber 0..1 string Número do lote do imunobiológico (vacina)
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... Fatias para performer Σ 2..2 BackboneElement Who performed event
Fatia: Não ordenado, Fechado por profile:actor
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:estabelecimento Σ 1..1 BackboneElement Who performed event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Estabelecimento de Saúde) Estabelecimento de Saúde
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... performer:profissional Σ 1..1 BackboneElement Who performed event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept What type of performance was done
Vínculo: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
..... actor Σ 1..1 Reference(Profissional) Profissional de Saúde
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Vínculo: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Vínculo: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Vínculo: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Vínculo: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Vínculo: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... series 1..1 string Número da dose no protocolo (considerando a sequência de doses para cada tipo de vacina dentro do protocolo).
.... authority 1..1 Reference(Organization) Indica a autoridade que publicou o protocolo que está sendo seguido.
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Vínculo: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... Fatias para doseNumber[x] 1..1 Dose number within series
Fatia: Não ordenado, Aberto por type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberString 0..1 string Posição nominal em uma série
.... Fatias para seriesDoses[x] 1..1 Recommended number of doses for immunity
Fatia: Não ordenado, Aberto por type:$this
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
..... seriesDoses[x]:seriesDosesString 0..1 string Conjunto de recomendações seguido pelo vacinador que administrou a dose

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeValueSet / CódigoURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From a norma FHIR
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From a norma FHIR
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From a norma FHIR
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From a norma FHIR
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:estabelecimento.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:estabelecimento.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.performer:profissional.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.performer:profissional.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From a norma FHIR
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From a norma FHIR
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From a norma FHIR
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From a norma FHIR
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From a norma FHIR

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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

Essa estrutura é derivada de Immunization

Resumo

Obrigatório: 7 elementos(5 aninhado obrigatoriamente elementos)

Estruturas

Esta estrutura refere-se a estas outras estruturas:

Fatias

Esta estrutura define os seguintes Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.performer (Closed)
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.seriesDoses[x]

 

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