Guia de Implementação da SES GO - Saúde da Mulher
1.0.0 - draft BR

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

Perfil: ImunizacaoGravidez - Descrição detalhada

Draft as of 2025-12-11

Definições para imunizacao-gravidez perfil.

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Immunization
2. Immunization.vaccineCode
Definição

Identifica o nome do imunobiológico administrado na gestante pela rede pública ou privada.

CurtoImunobiológico
VínculoOs códigos DEVERÃO ser retirados de Imunização gestante
(required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/imunizacao-gestante)
4. Immunization.patient
Definição

Referência ao Cidadão Identificado.

CurtoIdentificador nacional da cidadã/gestante.
TipoReference(Indivíduo)
6. Immunization.patient.identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo1..?
8. Immunization.patient.identifier.system
Controlo1..?
Valor do padrãohttps://fhir.saude.go.gov.br/sid/cpf
10. Immunization.patient.identifier.value
Controlo1..?
12. Immunization.encounter
Controlo1..?
TipoReference(Consulta acompanhamento gestante)
14. Immunization.occurrence[x]
[x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
SlicingEste elemento introduz um conjunto de fatias em Immunization.occurrence[x]. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • type @ $this
  • 16. Immunization.occurrence[x]:occurrenceDateTime
    Nome da fatiaoccurrenceDateTime
    Controlo1..1
    TipodateTime
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    InvariantesDataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
    18. Immunization.protocolApplied
    Controlo1..?
    20. Immunization.protocolApplied.doseNumber[x]
    Definição

    Identifica o registro da dose da vacina administrada na gestante. 1ª dose; 2ª dose; 3ª dose; 1ºReforço; 2º reforço; 3º reforço; Dose adicional; Dose única.

    CurtoDose do imunobiológico
    VínculoOs códigos DEVERÃO ser retirados de Dose Administrada Gestante
    (required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/dose-administrada-gestante)
    Tipostring, positiveInt
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão

    Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

    0. Immunization
    Definição

    Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

    CurtoImmunization event information
    Controlo0..*
    É modificadorfalse
    Resumofalse
    Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. Immunization.implicitRules
    Definição

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    CurtoA set of rules under which this content was created
    Comentários

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Controlo0..1
    Tipouri
    É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Immunization.modifierExtension
    Definição

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    CurtoExtensions that cannot be ignored
    Comentários

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Controlo0..*
    TipoExtension
    É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Resumofalse
    Requisitos

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Nomes alternativosextensions, user content
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. Immunization.status
    Definição

    Indicates the current status of the immunization event.

    Curtocompleted | entered-in-error | not-done
    Comentários

    Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)

    A set of codes indicating the current status of an Immunization.

    Tipocode
    É modificadortrue porque This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Immunization.vaccineCode
    Definição

    Identifica o nome do imunobiológico administrado na gestante pela rede pública ou privada.


    Vaccine that was administered or was to be administered.

    CurtoImunobiológicoVaccine product administered
    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de Para exemplos de códigos, ver Imunização gestantehttp://hl7.org/fhir/ValueSet/vaccine-code
    (required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/imunizacao-gestante)
    TipoCodeableConcept
    É modificadorfalse
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Immunization.patient
    Definição

    Referência ao Cidadão Identificado.


    The patient who either received or did not receive the immunization.

    CurtoIdentificador nacional da cidadã/gestante.Who was immunized
    Controlo1..1
    TipoReference(Indivíduo, Patient)
    É modificadorfalse
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Immunization.patient.identifier
    Definição

    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

    CurtoLogical reference, when literal reference is not known
    Comentários

    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

    NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
    Controlo10..1
    TipoIdentifier
    É modificadorfalse
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Immunization.patient.identifier.use
    Definição

    The purpose of this identifier.

    Curtousual | official | temp | secondary | old (If known)
    Comentários

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Controlo0..1
    VínculoOs códigos DEVERÃO ser retirados de IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Tipocode
    É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Requisitos

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Immunization.patient.identifier.system
    Definição

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    CurtoThe namespace for the identifier value
    Comentários

    Identifier.system is always case sensitive.

    Controlo10..1
    Tipouri
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Requisitos

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Valor do padrãohttps://fhir.saude.go.gov.br/sid/cpf
    ExemploGeneral: http://www.acme.com/identifiers/patient
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Immunization.patient.identifier.value
    Definição

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    CurtoThe value that is unique
    Comentários

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Controlo10..1
    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    ExemploGeneral: 123456
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Immunization.encounter
    Definição

    The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

    CurtoEncounter immunization was part of
    Controlo10..1
    TipoReference(Consulta acompanhamento gestante, Encounter)
    É modificadorfalse
    Resumofalse
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Immunization.occurrence[x]
    Definição

    Date vaccine administered or was to be administered.

    CurtoVaccine administration date
    Comentários

    When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

    Controlo1..1
    TipodateTime, string
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingEste elemento introduz um conjunto de fatias em Immunization.occurrence[x]. As fatias sãoNão ordenado e Closede pode ser diferenciado utilizando os seguintes discriminadores:
    • type @ $this
    • 24. Immunization.occurrence[x]:occurrenceDateTime
      Nome da fatiaoccurrenceDateTime
      Definição

      Date vaccine administered or was to be administered.

      CurtoVaccine administration date
      Comentários

      When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

      Controlo1..1
      TipodateTime, string
      [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      DataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
      26. Immunization.isSubpotent
      Definição

      Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

      CurtoDose potency
      Comentários

      Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

      Controlo0..1
      Tipoboolean
      É modificadortrue porque This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Significado em caso de faltaBy default, a dose should be considered to be potent.
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Immunization.protocolApplied
      Definição

      The protocol (set of recommendations) being followed by the provider who administered the dose.

      CurtoProtocol followed by the provider
      Controlo10..*
      TipoBackboneElement
      É modificadorfalse
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Immunization.protocolApplied.modifierExtension
      Definição

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      CurtoExtensions that cannot be ignored even if unrecognized
      Comentários

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Controlo0..*
      TipoExtension
      É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Resumotrue
      Requisitos

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Nomes alternativosextensions, user content, modifiers
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      32. Immunization.protocolApplied.doseNumber[x]
      Definição

      Identifica o registro da dose da vacina administrada na gestante. 1ª dose; 2ª dose; 3ª dose; 1ºReforço; 2º reforço; 3º reforço; Dose adicional; Dose única.


      Nominal position in a series.

      CurtoDose do imunobiológicoDose number within series
      Comentários

      The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de Para códigos, ver Dose Administrada Gestante
      (required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/dose-administrada-gestante)
      Tipostring, positiveInt
      [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

      0. Immunization
      Definição

      Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

      CurtoImmunization event information
      Controlo0..*
      É modificadorfalse
      Resumofalse
      Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. Immunization.id
      Definição

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      CurtoLogical id of this artifact
      Comentários

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Controlo0..1
      Tipoid
      É modificadorfalse
      Resumotrue
      4. Immunization.meta
      Definição

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      CurtoMetadata about the resource
      Controlo0..1
      TipoMeta
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Immunization.implicitRules
      Definição

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      CurtoA set of rules under which this content was created
      Comentários

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Controlo0..1
      Tipouri
      É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Immunization.language
      Definição

      The base language in which the resource is written.

      CurtoLanguage of the resource content
      Comentários

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Controlo0..1
      VínculoOs códigos DEVERÃO ser retirados de CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Vínculos adicionaisObjetivo
      AllLanguagesVínculo máximo
      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Immunization.text
      Definição

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      CurtoText summary of the resource, for human interpretation
      Comentários

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Controlo0..1
      TipoNarrative
      É modificadorfalse
      Resumofalse
      Nomes alternativosnarrative, html, xhtml, display
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Immunization.contained
      Definição

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      CurtoContained, inline Resources
      Comentários

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Controlo0..*
      TipoResource
      É modificadorfalse
      Resumofalse
      Nomes alternativosinline resources, anonymous resources, contained resources
      14. Immunization.extension
      Definição

      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      CurtoAdditional content defined by implementations
      Comentários

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. Immunization.modifierExtension
      Definição

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      CurtoExtensions that cannot be ignored
      Comentários

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Controlo0..*
      TipoExtension
      É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Resumofalse
      Requisitos

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. Immunization.identifier
      Definição

      A unique identifier assigned to this immunization record.

      CurtoBusiness identifier
      NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
      Controlo0..*
      TipoIdentifier
      É modificadorfalse
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Immunization.status
      Definição

      Indicates the current status of the immunization event.

      Curtocompleted | entered-in-error | not-done
      Comentários

      Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de ImmunizationStatusCodes
      (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)

      A set of codes indicating the current status of an Immunization.

      Tipocode
      É modificadortrue porque This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Immunization.statusReason
      Definição

      Indicates the reason the immunization event was not performed.

      CurtoReason not done
      Comentários

      This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

      Controlo0..1
      VínculoPara exemplos de códigos, ver ImmunizationStatusReasonCodes
      (example to http://hl7.org/fhir/ValueSet/immunization-status-reason)

      The reason why a vaccine was not administered.

      TipoCodeableConcept
      É modificadorfalse
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Immunization.vaccineCode
      Definição

      Identifica o nome do imunobiológico administrado na gestante pela rede pública ou privada.

      CurtoImunobiológico
      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de Imunização gestante
      (required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/imunizacao-gestante)
      TipoCodeableConcept
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Immunization.patient
      Definição

      Referência ao Cidadão Identificado.

      CurtoIdentificador nacional da cidadã/gestante.
      Controlo1..1
      TipoReference(Indivíduo)
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Immunization.patient.id
      Definição

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      CurtoUnique id for inter-element referencing
      Controlo0..1
      Tipostring
      É modificadorfalse
      Formato XMLNo formato XML, esta propriedade é representada como um atributo.
      Resumofalse
      30. Immunization.patient.extension
      Definição

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      CurtoAdditional content defined by implementations
      Comentários

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingEste elemento introduz um conjunto de fatias em Immunization.patient.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 32. Immunization.patient.reference
        Definição

        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

        CurtoLiteral reference, Relative, internal or absolute URL
        Comentários

        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

        Controlo0..1
        Este elemento é afetado pelas seguintes invariantes: ref-1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Immunization.patient.type
        Definição

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        CurtoType the reference refers to (e.g. "Patient")
        Comentários

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Controlo0..1
        VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceType
        (extensible to http://hl7.org/fhir/ValueSet/resource-types)

        Aa resource (or, for logical models, the URI of the logical model).

        Tipouri
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Immunization.patient.identifier
        Definição

        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

        CurtoLogical reference, when literal reference is not known
        Comentários

        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

        NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
        Controlo1..1
        TipoIdentifier
        É modificadorfalse
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Immunization.patient.identifier.id
        Definição

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        CurtoUnique id for inter-element referencing
        Controlo0..1
        Tipostring
        É modificadorfalse
        Formato XMLNo formato XML, esta propriedade é representada como um atributo.
        Resumofalse
        40. Immunization.patient.identifier.extension
        Definição

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        CurtoAdditional content defined by implementations
        Comentários

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Controlo0..*
        TipoExtension
        É modificadorfalse
        Resumofalse
        Nomes alternativosextensions, user content
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingEste elemento introduz um conjunto de fatias em Immunization.patient.identifier.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
        • value @ url
        • 42. Immunization.patient.identifier.use
          Definição

          The purpose of this identifier.

          Curtousual | official | temp | secondary | old (If known)
          Comentários

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Controlo0..1
          VínculoOs códigos DEVERÃO ser retirados de IdentifierUse
          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

          Identifies the purpose for this identifier, if known .

          Tipocode
          É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          Resumotrue
          Requisitos

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. Immunization.patient.identifier.type
          Definição

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          CurtoDescription of identifier
          Comentários

          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

          Controlo0..1
          VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de Identifier Type Codes
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

          TipoCodeableConcept
          É modificadorfalse
          Resumotrue
          Requisitos

          Allows users to make use of identifiers when the identifier system is not known.

          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. Immunization.patient.identifier.system
          Definição

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          CurtoThe namespace for the identifier value
          Comentários

          Identifier.system is always case sensitive.

          Controlo1..1
          Tipouri
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          Resumotrue
          Requisitos

          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

          Valor do padrãohttps://fhir.saude.go.gov.br/sid/cpf
          ExemploGeneral: http://www.acme.com/identifiers/patient
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. Immunization.patient.identifier.value
          Definição

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          CurtoThe value that is unique
          Comentários

          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Controlo1..1
          Tipostring
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          Resumotrue
          ExemploGeneral: 123456
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. Immunization.patient.identifier.period
          Definição

          Time period during which identifier is/was valid for use.

          CurtoTime period when id is/was valid for use
          Controlo0..1
          TipoPeriod
          É modificadorfalse
          Resumotrue
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. Immunization.patient.identifier.assigner
          Definição

          Organization that issued/manages the identifier.

          CurtoOrganization that issued id (may be just text)
          Comentários

          The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

          Controlo0..1
          TipoReference(Organization)
          É modificadorfalse
          Resumotrue
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. Immunization.patient.display
          Definição

          Plain text narrative that identifies the resource in addition to the resource reference.

          CurtoText alternative for the resource
          Comentários

          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

          Controlo0..1
          Tipostring
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          Resumotrue
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. Immunization.encounter
          Definição

          The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

          CurtoEncounter immunization was part of
          Controlo1..1
          TipoReference(Consulta acompanhamento gestante)
          É modificadorfalse
          Resumofalse
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. Immunization.occurrence[x]
          Definição

          Date vaccine administered or was to be administered.

          CurtoVaccine administration date
          Comentários

          When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

          Controlo1..1
          TipodateTime
          [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          Resumotrue
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingEste elemento introduz um conjunto de fatias em Immunization.occurrence[x]. As fatias sãoNão ordenado e Closede pode ser diferenciado utilizando os seguintes discriminadores:
          • type @ $this
          • 60. Immunization.occurrence[x]:occurrenceDateTime
            Nome da fatiaoccurrenceDateTime
            Definição

            Date vaccine administered or was to be administered.

            CurtoVaccine administration date
            Comentários

            When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

            Controlo1..1
            TipodateTime
            [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            DataComPrecisaoDeDia: Data deve ter a precisão de dia ($this.toString().length() = 10)
            62. Immunization.recorded
            Definição

            The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

            CurtoWhen the immunization was first captured in the subject's record
            Controlo0..1
            TipodateTime
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Immunization.primarySource
            Definição

            An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

            CurtoIndicates context the data was recorded in
            Comentários

            Reflects the “reliability” of the content.

            Controlo0..1
            Tipoboolean
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Immunization.reportOrigin
            Definição

            The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

            CurtoIndicates the source of a secondarily reported record
            Comentários

            Should not be populated if primarySource = True, not required even if primarySource = False.

            Controlo0..1
            VínculoPara exemplos de códigos, ver ImmunizationOriginCodes
            (example to http://hl7.org/fhir/ValueSet/immunization-origin)

            The source of the data for a record which is not from a primary source.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Immunization.location
            Definição

            The service delivery location where the vaccine administration occurred.

            CurtoWhere immunization occurred
            Controlo0..1
            TipoReference(Location)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. Immunization.manufacturer
            Definição

            Name of vaccine manufacturer.

            CurtoVaccine manufacturer
            Controlo0..1
            TipoReference(Organization)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. Immunization.lotNumber
            Definição

            Lot number of the vaccine product.

            CurtoVaccine lot number
            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. Immunization.expirationDate
            Definição

            Date vaccine batch expires.

            CurtoVaccine expiration date
            Controlo0..1
            Tipodate
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. Immunization.site
            Definição

            Body site where vaccine was administered.

            CurtoBody site vaccine was administered
            Controlo0..1
            VínculoPara exemplos de códigos, ver CodesForImmunizationSiteOfAdministration
            (example to http://hl7.org/fhir/ValueSet/immunization-site)

            The site at which the vaccine was administered.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. Immunization.route
            Definição

            The path by which the vaccine product is taken into the body.

            CurtoHow vaccine entered body
            Controlo0..1
            VínculoPara exemplos de códigos, ver ImmunizationRouteCodes
            (example to http://hl7.org/fhir/ValueSet/immunization-route)

            The route by which the vaccine was administered.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. Immunization.doseQuantity
            Definição

            The quantity of vaccine product that was administered.

            CurtoAmount of vaccine administered
            Controlo0..1
            TipoQuantity(SimpleQuantity)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Immunization.performer
            Definição

            Indicates who performed the immunization event.

            CurtoWho performed event
            Controlo0..*
            TipoBackboneElement
            É modificadorfalse
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Immunization.performer.id
            Definição

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            CurtoUnique id for inter-element referencing
            Controlo0..1
            Tipostring
            É modificadorfalse
            Formato XMLNo formato XML, esta propriedade é representada como um atributo.
            Resumofalse
            86. Immunization.performer.extension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            CurtoAdditional content defined by implementations
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadorfalse
            Resumofalse
            Nomes alternativosextensions, user content
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            88. Immunization.performer.modifierExtension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            CurtoExtensions that cannot be ignored even if unrecognized
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Resumotrue
            Requisitos

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Nomes alternativosextensions, user content, modifiers
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            90. Immunization.performer.function
            Definição

            Describes the type of performance (e.g. ordering provider, administering provider, etc.).

            CurtoWhat type of performance was done
            Controlo0..1
            VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ImmunizationFunctionCodes
            (extensible to http://hl7.org/fhir/ValueSet/immunization-function)

            The role a practitioner or organization plays in the immunization event.

            TipoCodeableConcept
            É modificadorfalse
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Immunization.performer.actor
            Definição

            The practitioner or organization who performed the action.

            CurtoIndividual or organization who was performing
            Comentários

            When the individual practitioner who performed the action is known, it is best to send.

            Controlo1..1
            TipoReference(Practitioner, PractitionerRole, Organization)
            É modificadorfalse
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. Immunization.note
            Definição

            Extra information about the immunization that is not conveyed by the other attributes.

            CurtoAdditional immunization notes
            Controlo0..*
            TipoAnnotation
            É modificadorfalse
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            96. Immunization.reasonCode
            Definição

            Reasons why the vaccine was administered.

            CurtoWhy immunization occurred
            Controlo0..*
            VínculoPara exemplos de códigos, ver ImmunizationReasonCodes
            (example to http://hl7.org/fhir/ValueSet/immunization-reason)

            The reason why a vaccine was administered.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            98. Immunization.reasonReference
            Definição

            Condition, Observation or DiagnosticReport that supports why the immunization was administered.

            CurtoWhy immunization occurred
            Controlo0..*
            TipoReference(Condition, Observation, DiagnosticReport)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. Immunization.isSubpotent
            Definição

            Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

            CurtoDose potency
            Comentários

            Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

            Controlo0..1
            Tipoboolean
            É modificadortrue porque This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Significado em caso de faltaBy default, a dose should be considered to be potent.
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            102. Immunization.subpotentReason
            Definição

            Reason why a dose is considered to be subpotent.

            CurtoReason for being subpotent
            Controlo0..*
            VínculoPara exemplos de códigos, ver ImmunizationSubpotentReason
            (example to http://hl7.org/fhir/ValueSet/immunization-subpotent-reason)

            The reason why a dose is considered to be subpotent.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. Immunization.education
            Definição

            Educational material presented to the patient (or guardian) at the time of vaccine administration.

            CurtoEducational material presented to patient
            Controlo0..*
            TipoBackboneElement
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            imm-1: One of documentType or reference SHALL be present (documentType.exists() or reference.exists())
            106. Immunization.education.id
            Definição

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            CurtoUnique id for inter-element referencing
            Controlo0..1
            Tipostring
            É modificadorfalse
            Formato XMLNo formato XML, esta propriedade é representada como um atributo.
            Resumofalse
            108. Immunization.education.extension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            CurtoAdditional content defined by implementations
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadorfalse
            Resumofalse
            Nomes alternativosextensions, user content
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            110. Immunization.education.modifierExtension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            CurtoExtensions that cannot be ignored even if unrecognized
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Resumotrue
            Requisitos

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Nomes alternativosextensions, user content, modifiers
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            112. Immunization.education.documentType
            Definição

            Identifier of the material presented to the patient.

            CurtoEducational material document identifier
            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            114. Immunization.education.reference
            Definição

            Reference pointer to the educational material given to the patient if the information was on line.

            CurtoEducational material reference pointer
            Controlo0..1
            Tipouri
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            116. Immunization.education.publicationDate
            Definição

            Date the educational material was published.

            CurtoEducational material publication date
            Controlo0..1
            TipodateTime
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            118. Immunization.education.presentationDate
            Definição

            Date the educational material was given to the patient.

            CurtoEducational material presentation date
            Controlo0..1
            TipodateTime
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            120. Immunization.programEligibility
            Definição

            Indicates a patient's eligibility for a funding program.

            CurtoPatient eligibility for a vaccination program
            Controlo0..*
            VínculoPara exemplos de códigos, ver ImmunizationProgramEligibility
            (example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility)

            The patient's eligibility for a vaccation program.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            122. Immunization.fundingSource
            Definição

            Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

            CurtoFunding source for the vaccine
            Controlo0..1
            VínculoPara exemplos de códigos, ver ImmunizationFundingSource
            (example to http://hl7.org/fhir/ValueSet/immunization-funding-source)

            The source of funding used to purchase the vaccine administered.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            124. Immunization.reaction
            Definição

            Categorical data indicating that an adverse event is associated in time to an immunization.

            CurtoDetails of a reaction that follows immunization
            Comentários

            A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

            Controlo0..*
            TipoBackboneElement
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            126. Immunization.reaction.id
            Definição

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            CurtoUnique id for inter-element referencing
            Controlo0..1
            Tipostring
            É modificadorfalse
            Formato XMLNo formato XML, esta propriedade é representada como um atributo.
            Resumofalse
            128. Immunization.reaction.extension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            CurtoAdditional content defined by implementations
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadorfalse
            Resumofalse
            Nomes alternativosextensions, user content
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            130. Immunization.reaction.modifierExtension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            CurtoExtensions that cannot be ignored even if unrecognized
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Resumotrue
            Requisitos

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Nomes alternativosextensions, user content, modifiers
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            132. Immunization.reaction.date
            Definição

            Date of reaction to the immunization.

            CurtoWhen reaction started
            Controlo0..1
            TipodateTime
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            134. Immunization.reaction.detail
            Definição

            Details of the reaction.

            CurtoAdditional information on reaction
            Controlo0..1
            TipoReference(Observation)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            136. Immunization.reaction.reported
            Definição

            Self-reported indicator.

            CurtoIndicates self-reported reaction
            Controlo0..1
            Tipoboolean
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            138. Immunization.protocolApplied
            Definição

            The protocol (set of recommendations) being followed by the provider who administered the dose.

            CurtoProtocol followed by the provider
            Controlo1..*
            TipoBackboneElement
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            140. Immunization.protocolApplied.id
            Definição

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            CurtoUnique id for inter-element referencing
            Controlo0..1
            Tipostring
            É modificadorfalse
            Formato XMLNo formato XML, esta propriedade é representada como um atributo.
            Resumofalse
            142. Immunization.protocolApplied.extension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            CurtoAdditional content defined by implementations
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadorfalse
            Resumofalse
            Nomes alternativosextensions, user content
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            144. Immunization.protocolApplied.modifierExtension
            Definição

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            CurtoExtensions that cannot be ignored even if unrecognized
            Comentários

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Controlo0..*
            TipoExtension
            É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Resumotrue
            Requisitos

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Nomes alternativosextensions, user content, modifiers
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            146. Immunization.protocolApplied.series
            Definição

            One possible path to achieve presumed immunity against a disease - within the context of an authority.

            CurtoName of vaccine series
            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            148. Immunization.protocolApplied.authority
            Definição

            Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

            CurtoWho is responsible for publishing the recommendations
            Controlo0..1
            TipoReference(Organization)
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            150. Immunization.protocolApplied.targetDisease
            Definição

            The vaccine preventable disease the dose is being administered against.

            CurtoVaccine preventatable disease being targetted
            Controlo0..*
            VínculoPara exemplos de códigos, ver ImmunizationTargetDiseaseCodes
            (example to http://hl7.org/fhir/ValueSet/immunization-target-disease)

            The vaccine preventable disease the dose is being administered for.

            TipoCodeableConcept
            É modificadorfalse
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            152. Immunization.protocolApplied.doseNumber[x]
            Definição

            Identifica o registro da dose da vacina administrada na gestante. 1ª dose; 2ª dose; 3ª dose; 1ºReforço; 2º reforço; 3º reforço; Dose adicional; Dose única.

            CurtoDose do imunobiológico
            Comentários

            The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

            Controlo1..1
            VínculoOs códigos DEVERÃO ser retirados de Dose Administrada Gestante
            (required to https://fhir.saude.go.gov.br/r4/saude-mulher/ValueSet/dose-administrada-gestante)
            Tipostring
            [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            154. Immunization.protocolApplied.seriesDoses[x]
            Definição

            The recommended number of doses to achieve immunity.

            CurtoRecommended number of doses for immunity
            Comentários

            The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

            Controlo0..1
            TipoEscolha de: positiveInt, string
            [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumofalse
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))