Guia de Implementação da SES GO - CORE
0.0.1 - draft Brazil flag

Guia de Implementação da SES GO - CORE - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ImunobiologicoAdministrado - Detailed Descriptions

Active as of 2024-04-15

Definitions for the imunobiologico-administrado resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Immunization
2. Immunization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
4. Immunization.status
Definition

Geralmente será definido para mostrar que a imunização foi concluída ou não. Este elemento é rotulado como modificador porque o status contém códigos que marcam o recurso como inválido no momento.

ShortIndica o status atual da administração do Imunobiológico.
Pattern Valuecompleted
6. Immunization.status.id
Control0..0
8. Immunization.status.extension
Control0..0
10. Immunization.statusReason
Control0..0
12. Immunization.vaccineCode
Definition

Vacina que foi administrada ou deveria ser administrada.

ShortProduto da vacina administrada
BindingThe codes SHALL be taken from Imunobiológico
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0)
14. Immunization.vaccineCode.id
Control0..0
16. Immunization.vaccineCode.extension
Control0..0
18. Immunization.vaccineCode.coding
Control1..1
20. Immunization.vaccineCode.coding.id
Control0..0
22. Immunization.vaccineCode.coding.extension
Control0..0
24. Immunization.vaccineCode.coding.system
Control1..?
26. Immunization.vaccineCode.coding.system.id
Control0..0
28. Immunization.vaccineCode.coding.system.extension
Control0..0
30. Immunization.vaccineCode.coding.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
32. Immunization.vaccineCode.coding.code
Control1..?
34. Immunization.vaccineCode.coding.code.id
Control0..0
36. Immunization.vaccineCode.coding.code.extension
Control0..0
38. Immunization.vaccineCode.coding.display
Control0..0
40. Immunization.vaccineCode.coding.userSelected
Control0..0
42. Immunization.vaccineCode.text
Control0..0
44. Immunization.patient
Definition

O paciente que recebeu ou não recebeu a imunização.

ShortPara quem esta imunização foi administrada
TypeReference(Indivíduo)
46. Immunization.patient.id
Control0..0
48. Immunization.patient.extension
Control0..0
50. Immunization.encounter
Control0..0
52. Immunization.occurrence[x]
Definition

Data em que a vacina foi administrada ou deveria ser administrada.

ShortData de administração da vacina
TypedateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Immunization.occurrence[x].id
Control0..0
56. Immunization.occurrence[x].extension
Control0..0
58. Immunization.recorded
Control0..0
60. Immunization.primarySource
Control0..0
62. Immunization.reportOrigin
Control0..0
64. Immunization.location
Control0..0
66. Immunization.manufacturer
Control0..0
68. Immunization.lotNumber
Definition

O número do lote do produto da vacina.

ShortNúmero do lote da vacina
Control1..?
70. Immunization.lotNumber.id
Control0..0
72. Immunization.lotNumber.extension
Control0..0
74. Immunization.expirationDate
Control0..0
76. Immunization.site
Control0..0
78. Immunization.route
Control0..0
80. Immunization.doseQuantity
Control0..0
82. Immunization.performer
Control0..0
84. Immunization.note
Control0..0
86. Immunization.reasonCode
Control0..0
88. Immunization.reasonReference
Control0..0
90. Immunization.isSubpotent
Control0..0
92. Immunization.subpotentReason
Control0..0
94. Immunization.education
Control0..0
96. Immunization.programEligibility
Control0..0
98. Immunization.fundingSource
Control0..0
100. Immunization.reaction
Control0..0
102. Immunization.protocolApplied
ShortProtocolo seguido pelo provedor
Control1..1
104. Immunization.protocolApplied.id
Control0..0
106. Immunization.protocolApplied.extension
Control0..0
108. Immunization.protocolApplied.modifierExtension
Control0..0
110. Immunization.protocolApplied.series
Control0..0
112. Immunization.protocolApplied.authority
Control0..0
114. Immunization.protocolApplied.targetDisease
Control0..0
116. Immunization.protocolApplied.doseNumber[x]
Definition

Posição nominal em uma série

ShortNúmero da dose dentro da série
Typestring, positiveInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
118. Immunization.protocolApplied.doseNumber[x].id
Control0..0
120. Immunization.protocolApplied.doseNumber[x].extension
Control0..0
122. Immunization.protocolApplied.seriesDoses[x]
Definition

Número recomendado de doses para imunização completa

ShortNúmero recomendado de doses para imunidade
Control1..?
TypepositiveInt, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. Immunization.protocolApplied.seriesDoses[x].id
Control0..0
126. Immunization.protocolApplied.seriesDoses[x].extension
Control0..0

Guidance on how to interpret the contents of this table can be found here

0. Immunization
Definition

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.

ShortImmunization event information
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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
Definition

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.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Immunization.modifierExtension
Definition

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).

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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.

Alternate Namesextensions, user content
Invariantsele-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.identifier
Definition

A unique identifier assigned to this immunization record.

ShortBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Immunization.status
Definition

Geralmente será definido para mostrar que a imunização foi concluída ou não. Este elemento é rotulado como modificador porque o status contém códigos que marcam o recurso como inválido no momento.


Indicates the current status of the immunization event.

ShortIndica o status atual da administração do Imunobiológico.completed | entered-in-error | not-done
Comments

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.

Control1..1
BindingThe codes SHALL be taken from 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.

Typecode
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuecompleted
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Immunization.status.id
Definition

unique id for the element within a resource (for internal references)


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

Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
Control0..01
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
12. Immunization.status.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
Comments

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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Immunization.statusReason
Definition

Indicates the reason the immunization event was not performed.

ShortReason not done
Comments

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

Control0..01
BindingFor example codes, see ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason
(example to http://hl7.org/fhir/ValueSet/immunization-status-reason)

The reason why a vaccine was not administered.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Immunization.vaccineCode
Definition

Vacina que foi administrada ou deveria ser administrada.


Vaccine that was administered or was to be administered.

ShortProduto da vacina administradaVaccine product administered
Control1..1
BindingThe codes SHALL be taken from For example codes, see Imunobiológicohttp://hl7.org/fhir/ValueSet/vaccine-code
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Immunization.vaccineCode.id
Definition

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

ShortUnique id for inter-element referencing
Control0..01
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
20. Immunization.vaccineCode.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
Comments

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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Immunization.vaccineCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 22. Immunization.vaccineCode.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..1*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Immunization.vaccineCode.coding.id
    Definition

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

    ShortUnique id for inter-element referencing
    Control0..01
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    26. Immunization.vaccineCode.coding.extension
    Definition

    An Extension


    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.

    ShortExtensionAdditional content defined by implementations
    Comments

    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.

    Control0..0*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on Immunization.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 28. Immunization.vaccineCode.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Immunization.vaccineCode.coding.system.id
      Definition

      unique id for the element within a resource (for internal references)


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

      Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
      Control0..01
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      32. Immunization.vaccineCode.coding.system.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional content defined by implementations
      Comments

      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.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      34. Immunization.vaccineCode.coding.version
      Definition

      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

      ShortVersion of the system - if relevant
      Comments

      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Immunization.vaccineCode.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Immunization.vaccineCode.coding.code.id
      Definition

      unique id for the element within a resource (for internal references)


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

      Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
      Control0..01
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      40. Immunization.vaccineCode.coding.code.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional content defined by implementations
      Comments

      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.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      42. Immunization.vaccineCode.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system
      Control0..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Immunization.vaccineCode.coding.userSelected
      Definition

      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

      ShortIf this coding was chosen directly by the user
      Comments

      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

      Control0..01
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Immunization.vaccineCode.text
      Definition

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      ShortPlain text representation of the concept
      Comments

      Very often the text is the same as a displayName of one of the codings.

      Control0..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Immunization.patient
      Definition

      O paciente que recebeu ou não recebeu a imunização.


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

      ShortPara quem esta imunização foi administradaWho was immunized
      Control1..1
      TypeReference(Indivíduo, Patient)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Immunization.patient.id
      Definition

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

      ShortUnique id for inter-element referencing
      Control0..01
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      52. Immunization.patient.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional content defined by implementations
      Comments

      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.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      SlicingThis element introduces a set of slices on Immunization.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 54. Immunization.encounter
        Definition

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

        ShortEncounter immunization was part of
        Control0..01
        TypeReference(Encounter)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Immunization.occurrence[x]
        Definition

        Data em que a vacina foi administrada ou deveria ser administrada.


        Date vaccine administered or was to be administered.

        ShortData de administração da vacinaVaccine administration date
        Comments

        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.

        Control1..1
        TypedateTime, string
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Immunization.occurrence[x].id
        Definition

        unique id for the element within a resource (for internal references)


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

        Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        60. Immunization.occurrence[x].extension
        Definition

        An Extension


        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.

        ShortExtensionAdditional content defined by implementations
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        62. Immunization.recorded
        Definition

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

        ShortWhen the immunization was first captured in the subject's record
        Control0..01
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Immunization.primarySource
        Definition

        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.

        ShortIndicates context the data was recorded in
        Comments

        Reflects the “reliability” of the content.

        Control0..01
        Typeboolean
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Immunization.reportOrigin
        Definition

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

        ShortIndicates the source of a secondarily reported record
        Comments

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

        Control0..01
        BindingFor example codes, see ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin
        (example to http://hl7.org/fhir/ValueSet/immunization-origin)

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

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Immunization.location
        Definition

        The service delivery location where the vaccine administration occurred.

        ShortWhere immunization occurred
        Control0..01
        TypeReference(Location)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Immunization.manufacturer
        Definition

        Name of vaccine manufacturer.

        ShortVaccine manufacturer
        Control0..01
        TypeReference(Organization)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. Immunization.lotNumber
        Definition

        O número do lote do produto da vacina.


        Lot number of the vaccine product.

        ShortNúmero do lote da vacinaVaccine lot number
        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Immunization.lotNumber.id
        Definition

        unique id for the element within a resource (for internal references)


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

        Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        76. Immunization.lotNumber.extension
        Definition

        An Extension


        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.

        ShortExtensionAdditional content defined by implementations
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        78. Immunization.expirationDate
        Definition

        Date vaccine batch expires.

        ShortVaccine expiration date
        Control0..01
        Typedate
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        80. Immunization.site
        Definition

        Body site where vaccine was administered.

        ShortBody site vaccine was administered
        Control0..01
        BindingFor example codes, see CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site
        (example to http://hl7.org/fhir/ValueSet/immunization-site)

        The site at which the vaccine was administered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. Immunization.route
        Definition

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

        ShortHow vaccine entered body
        Control0..01
        BindingFor example codes, see ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route
        (example to http://hl7.org/fhir/ValueSet/immunization-route)

        The route by which the vaccine was administered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Immunization.doseQuantity
        Definition

        The quantity of vaccine product that was administered.

        ShortAmount of vaccine administered
        Control0..01
        TypeQuantity(SimpleQuantity)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. Immunization.performer
        Definition

        Indicates who performed the immunization event.

        ShortWho performed event
        Control0..0*
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        90. Immunization.note
        Definition

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

        ShortAdditional immunization notes
        Control0..0*
        TypeAnnotation
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        92. Immunization.reasonCode
        Definition

        Reasons why the vaccine was administered.

        ShortWhy immunization occurred
        Control0..0*
        BindingFor example codes, see ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason
        (example to http://hl7.org/fhir/ValueSet/immunization-reason)

        The reason why a vaccine was administered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. Immunization.reasonReference
        Definition

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

        ShortWhy immunization occurred
        Control0..0*
        TypeReference(Condition, Observation, DiagnosticReport)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        96. Immunization.isSubpotent
        Definition

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

        ShortDose potency
        Comments

        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.

        Control0..01
        Typeboolean
        Is Modifiertrue because 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.
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Meaning if MissingBy default, a dose should be considered to be potent.
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        98. Immunization.subpotentReason
        Definition

        Reason why a dose is considered to be subpotent.

        ShortReason for being subpotent
        Control0..0*
        BindingFor example codes, see ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason
        (example to http://hl7.org/fhir/ValueSet/immunization-subpotent-reason)

        The reason why a dose is considered to be subpotent.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        100. Immunization.education
        Definition

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

        ShortEducational material presented to patient
        Control0..0*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        imm-1: One of documentType or reference SHALL be present (documentType.exists() or reference.exists())
        103. Immunization.programEligibility
        Definition

        Indicates a patient's eligibility for a funding program.

        ShortPatient eligibility for a vaccination program
        Control0..0*
        BindingFor example codes, see ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility
        (example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility)

        The patient's eligibility for a vaccation program.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        105. Immunization.fundingSource
        Definition

        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).

        ShortFunding source for the vaccine
        Control0..01
        BindingFor example codes, see ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source
        (example to http://hl7.org/fhir/ValueSet/immunization-funding-source)

        The source of funding used to purchase the vaccine administered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        107. Immunization.reaction
        Definition

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

        ShortDetails of a reaction that follows immunization
        Comments

        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.

        Control0..0*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        110. Immunization.protocolApplied
        Definition

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

        ShortProtocolo seguido pelo provedorProtocol followed by the provider
        Control10..1*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        112. Immunization.protocolApplied.id
        Definition

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

        ShortUnique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        114. Immunization.protocolApplied.extension
        Definition

        An Extension


        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.

        ShortExtensionAdditional content defined by implementations
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        116. Immunization.protocolApplied.modifierExtension
        Definition

        An Extension


        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).

        ShortExtensionExtensions that cannot be ignored even if unrecognized
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        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.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-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())
        118. Immunization.protocolApplied.series
        Definition

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

        ShortName of vaccine series
        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        120. Immunization.protocolApplied.authority
        Definition

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

        ShortWho is responsible for publishing the recommendations
        Control0..01
        TypeReference(Organization)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        122. Immunization.protocolApplied.targetDisease
        Definition

        The vaccine preventable disease the dose is being administered against.

        ShortVaccine preventatable disease being targetted
        Control0..0*
        BindingFor example codes, see ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease
        (example to http://hl7.org/fhir/ValueSet/immunization-target-disease)

        The vaccine preventable disease the dose is being administered for.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        124. Immunization.protocolApplied.doseNumber[x]
        Definition

        Posição nominal em uma série


        Nominal position in a series.

        ShortNúmero da dose dentro da sérieDose number within series
        Comments

        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).

        Control1..1
        Typestring, positiveInt
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        126. Immunization.protocolApplied.doseNumber[x].id
        Definition

        unique id for the element within a resource (for internal references)


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

        Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        128. Immunization.protocolApplied.doseNumber[x].extension
        Definition

        An Extension


        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.

        ShortExtensionAdditional content defined by implementations
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        130. Immunization.protocolApplied.seriesDoses[x]
        Definition

        Número recomendado de doses para imunização completa


        The recommended number of doses to achieve immunity.

        ShortNúmero recomendado de doses para imunidadeRecommended number of doses for immunity
        Comments

        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).

        Control10..1
        TypepositiveInt, string
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        132. Immunization.protocolApplied.seriesDoses[x].id
        Definition

        unique id for the element within a resource (for internal references)


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

        Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        134. Immunization.protocolApplied.seriesDoses[x].extension
        Definition

        An Extension


        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.

        ShortExtensionAdditional content defined by implementations
        Comments

        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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

        Guidance on how to interpret the contents of this table can be found here

        0. Immunization
        Definition

        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.

        ShortImmunization event information
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Invariantsdom-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
        Definition

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

        ShortLogical id of this artifact
        Comments

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

        Control0..1
        Typeid
        Is Modifierfalse
        Summarytrue
        4. Immunization.meta
        Definition

        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.

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        6. Immunization.implicitRules
        Definition

        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.

        ShortA set of rules under which this content was created
        Comments

        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.

        Control0..1
        Typeuri
        Is Modifiertrue because 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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        8. Immunization.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        Comments

        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).

        Control0..1
        BindingThe codes SHOULD be taken from CommonLanguages
        (preferred to http://hl7.org/fhir/ValueSet/languages)

        A human language.

        Additional BindingsPurpose
        AllLanguagesMax Binding
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. Immunization.text
        Definition

        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.

        ShortText summary of the resource, for human interpretation
        Comments

        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.

        Control0..1
        TypeNarrative
        Is Modifierfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. Immunization.contained
        Definition

        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.

        ShortContained, inline Resources
        Comments

        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.

        Control0..*
        TypeResource
        Is Modifierfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        14. Immunization.extension
        Definition

        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.

        ShortAdditional content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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
        Definition

        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).

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        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.

        Alternate Namesextensions, user content
        Invariantsele-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
        Definition

        A unique identifier assigned to this immunization record.

        ShortBusiness identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..0
        TypeIdentifier
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Immunization.status
        Definition

        Geralmente será definido para mostrar que a imunização foi concluída ou não. Este elemento é rotulado como modificador porque o status contém códigos que marcam o recurso como inválido no momento.

        ShortIndica o status atual da administração do Imunobiológico.
        Comments

        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.

        Control1..1
        BindingThe codes SHALL be taken from ImmunizationStatusCodes
        (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)

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

        Typecode
        Is Modifiertrue because 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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern Valuecompleted
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Immunization.status.id
        Definition

        unique id for the element within a resource (for internal references)

        Shortxml:id (or equivalent in JSON)
        Control0..0
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        24. Immunization.status.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        26. Immunization.status.value
        Definition

        Primitive value for code

        ShortPrimitive value for code
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        28. Immunization.statusReason
        Definition

        Indicates the reason the immunization event was not performed.

        ShortReason not done
        Comments

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

        Control0..0
        BindingFor example codes, see ImmunizationStatusReasonCodes
        (example to http://hl7.org/fhir/ValueSet/immunization-status-reason)

        The reason why a vaccine was not administered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Immunization.vaccineCode
        Definition

        Vacina que foi administrada ou deveria ser administrada.

        ShortProduto da vacina administrada
        Control1..1
        BindingThe codes SHALL be taken from Imunobiológico
        (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0)
        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Immunization.vaccineCode.id
        Definition

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

        ShortUnique id for inter-element referencing
        Control0..0
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        34. Immunization.vaccineCode.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        SlicingThis element introduces a set of slices on Immunization.vaccineCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 36. Immunization.vaccineCode.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control1..1
          TypeCoding
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows for alternative encodings within a code system, and translations to other code systems.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. Immunization.vaccineCode.coding.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..0
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          40. Immunization.vaccineCode.coding.extension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-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())
          SlicingThis element introduces a set of slices on Immunization.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 42. Immunization.vaccineCode.coding.system
            Definition

            The identification of the code system that defines the meaning of the symbol in the code.

            ShortIdentity of the terminology system
            Comments

            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

            Control1..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to be unambiguous about the source of the definition of the symbol.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Immunization.vaccineCode.coding.system.id
            Definition

            unique id for the element within a resource (for internal references)

            Shortxml:id (or equivalent in JSON)
            Control0..0
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            46. Immunization.vaccineCode.coding.system.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-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())
            48. Immunization.vaccineCode.coding.system.value
            Definition

            The actual value

            ShortPrimitive value for uri
            Control0..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            50. Immunization.vaccineCode.coding.version
            Definition

            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

            ShortVersion of the system - if relevant
            Comments

            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Immunization.vaccineCode.coding.code
            Definition

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

            ShortSymbol in syntax defined by the system
            Control1..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to refer to a particular code in the system.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. Immunization.vaccineCode.coding.code.id
            Definition

            unique id for the element within a resource (for internal references)

            Shortxml:id (or equivalent in JSON)
            Control0..0
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            56. Immunization.vaccineCode.coding.code.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-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())
            58. Immunization.vaccineCode.coding.code.value
            Definition

            Primitive value for code

            ShortPrimitive value for code
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            60. Immunization.vaccineCode.coding.display
            Definition

            A representation of the meaning of the code in the system, following the rules of the system.

            ShortRepresentation defined by the system
            Control0..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Immunization.vaccineCode.coding.userSelected
            Definition

            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

            ShortIf this coding was chosen directly by the user
            Comments

            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

            Control0..0
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Immunization.vaccineCode.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Immunization.patient
            Definition

            O paciente que recebeu ou não recebeu a imunização.

            ShortPara quem esta imunização foi administrada
            Control1..1
            TypeReference(Indivíduo)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Immunization.patient.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..0
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            70. Immunization.patient.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-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())
            SlicingThis element introduces a set of slices on Immunization.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 72. Immunization.patient.reference
              Definition

              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.

              ShortLiteral reference, Relative, internal or absolute URL
              Comments

              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.

              Control0..1
              This element is affected by the following invariants: ref-1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. Immunization.patient.type
              Definition

              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).

              ShortType the reference refers to (e.g. "Patient")
              Comments

              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.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from ResourceType
              (extensible to http://hl7.org/fhir/ValueSet/resource-types)

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

              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. Immunization.patient.identifier
              Definition

              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.

              ShortLogical reference, when literal reference is not known
              Comments

              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).

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..1
              TypeIdentifier
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. Immunization.patient.display
              Definition

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

              ShortText alternative for the resource
              Comments

              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.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              80. Immunization.encounter
              Definition

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

              ShortEncounter immunization was part of
              Control0..0
              TypeReference(Encounter)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              82. Immunization.occurrence[x]
              Definition

              Data em que a vacina foi administrada ou deveria ser administrada.

              ShortData de administração da vacina
              Comments

              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.

              Control1..1
              TypedateTime
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              84. Immunization.occurrence[x].id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              86. Immunization.occurrence[x].extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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.occurrence[x].value
              Definition

              The actual value

              ShortPrimitive value for dateTime
              Control0..1
              TypedateTime
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              90. Immunization.recorded
              Definition

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

              ShortWhen the immunization was first captured in the subject's record
              Control0..0
              TypedateTime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              92. Immunization.primarySource
              Definition

              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.

              ShortIndicates context the data was recorded in
              Comments

              Reflects the “reliability” of the content.

              Control0..0
              Typeboolean
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. Immunization.reportOrigin
              Definition

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

              ShortIndicates the source of a secondarily reported record
              Comments

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

              Control0..0
              BindingFor example codes, see 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.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. Immunization.location
              Definition

              The service delivery location where the vaccine administration occurred.

              ShortWhere immunization occurred
              Control0..0
              TypeReference(Location)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. Immunization.manufacturer
              Definition

              Name of vaccine manufacturer.

              ShortVaccine manufacturer
              Control0..0
              TypeReference(Organization)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              100. Immunization.lotNumber
              Definition

              O número do lote do produto da vacina.

              ShortNúmero do lote da vacina
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              102. Immunization.lotNumber.id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              104. Immunization.lotNumber.extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              106. Immunization.lotNumber.value
              Definition

              The actual value

              ShortPrimitive value for string
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Max Length:1048576
              108. Immunization.expirationDate
              Definition

              Date vaccine batch expires.

              ShortVaccine expiration date
              Control0..0
              Typedate
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              110. Immunization.site
              Definition

              Body site where vaccine was administered.

              ShortBody site vaccine was administered
              Control0..0
              BindingFor example codes, see CodesForImmunizationSiteOfAdministration
              (example to http://hl7.org/fhir/ValueSet/immunization-site)

              The site at which the vaccine was administered.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              112. Immunization.route
              Definition

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

              ShortHow vaccine entered body
              Control0..0
              BindingFor example codes, see ImmunizationRouteCodes
              (example to http://hl7.org/fhir/ValueSet/immunization-route)

              The route by which the vaccine was administered.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              114. Immunization.doseQuantity
              Definition

              The quantity of vaccine product that was administered.

              ShortAmount of vaccine administered
              Control0..0
              TypeQuantity(SimpleQuantity)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              116. Immunization.performer
              Definition

              Indicates who performed the immunization event.

              ShortWho performed event
              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              123. Immunization.note
              Definition

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

              ShortAdditional immunization notes
              Control0..0
              TypeAnnotation
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              125. Immunization.reasonCode
              Definition

              Reasons why the vaccine was administered.

              ShortWhy immunization occurred
              Control0..0
              BindingFor example codes, see ImmunizationReasonCodes
              (example to http://hl7.org/fhir/ValueSet/immunization-reason)

              The reason why a vaccine was administered.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              127. Immunization.reasonReference
              Definition

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

              ShortWhy immunization occurred
              Control0..0
              TypeReference(Condition, Observation, DiagnosticReport)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              129. Immunization.isSubpotent
              Definition

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

              ShortDose potency
              Comments

              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.

              Control0..0
              Typeboolean
              Is Modifiertrue because 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.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Meaning if MissingBy default, a dose should be considered to be potent.
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              131. Immunization.subpotentReason
              Definition

              Reason why a dose is considered to be subpotent.

              ShortReason for being subpotent
              Control0..0
              BindingFor example codes, see ImmunizationSubpotentReason
              (example to http://hl7.org/fhir/ValueSet/immunization-subpotent-reason)

              The reason why a dose is considered to be subpotent.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              133. Immunization.education
              Definition

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

              ShortEducational material presented to patient
              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              142. Immunization.programEligibility
              Definition

              Indicates a patient's eligibility for a funding program.

              ShortPatient eligibility for a vaccination program
              Control0..0
              BindingFor example codes, see ImmunizationProgramEligibility
              (example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility)

              The patient's eligibility for a vaccation program.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              144. Immunization.fundingSource
              Definition

              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).

              ShortFunding source for the vaccine
              Control0..0
              BindingFor example codes, see ImmunizationFundingSource
              (example to http://hl7.org/fhir/ValueSet/immunization-funding-source)

              The source of funding used to purchase the vaccine administered.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              146. Immunization.reaction
              Definition

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

              ShortDetails of a reaction that follows immunization
              Comments

              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.

              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              154. Immunization.protocolApplied
              Definition

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

              ShortProtocolo seguido pelo provedor
              Control1..1
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              156. Immunization.protocolApplied.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              158. Immunization.protocolApplied.extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              160. Immunization.protocolApplied.modifierExtension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Invariantsele-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())
              162. Immunization.protocolApplied.series
              Definition

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

              ShortName of vaccine series
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              164. Immunization.protocolApplied.authority
              Definition

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

              ShortWho is responsible for publishing the recommendations
              Control0..0
              TypeReference(Organization)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              166. Immunization.protocolApplied.targetDisease
              Definition

              The vaccine preventable disease the dose is being administered against.

              ShortVaccine preventatable disease being targetted
              Control0..0
              BindingFor example codes, see ImmunizationTargetDiseaseCodes
              (example to http://hl7.org/fhir/ValueSet/immunization-target-disease)

              The vaccine preventable disease the dose is being administered for.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              168. Immunization.protocolApplied.doseNumber[x]
              Definition

              Posição nominal em uma série

              ShortNúmero da dose dentro da série
              Comments

              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).

              Control1..1
              Typestring
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              170. Immunization.protocolApplied.doseNumber[x].id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              172. Immunization.protocolApplied.doseNumber[x].extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              174. Immunization.protocolApplied.doseNumber[x].value
              Definition

              The actual value

              ShortPrimitive value for string
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Max Length:1048576
              176. Immunization.protocolApplied.seriesDoses[x]
              Definition

              Número recomendado de doses para imunização completa

              ShortNúmero recomendado de doses para imunidade
              Comments

              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).

              Control1..1
              TypepositiveInt
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              178. Immunization.protocolApplied.seriesDoses[x].id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              180. Immunization.protocolApplied.seriesDoses[x].extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              182. Immunization.protocolApplied.seriesDoses[x].value
              Definition

              Primitive value for positiveInt

              ShortPrimitive value for positiveInt
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse