BR.GOV.SAUDE.BR-CORE.FHIR\BRCoreImmunization - Definitions

idstring

Is Modifier false

Summary true

4. Immunization.meta

Definition

Metadados sobre o recurso

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.

Short Metadados sobre o recursoMetadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Immunization.implicitRules

Definition

Regras implícitas de rastreamento

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.

Short Regras implícitas de rastreamentoA 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.

Control 0..1

uri

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Immunization.language

Definition

Idioma do recurso

The base language in which the resource is written.

Short Idioma do recursoLanguage 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).

Control 0..1

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Immunization.text

Definition

Texto narrativo, resumo, instruções ou legenda sobre o recurso

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.

Short Texto narrativo, resumo, instruções ou legenda sobre o recursoText 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.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Immunization.contained

Definition

Recursos contidos no artefato

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.

Short Recursos contidos no artefatoContained, 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Immunization.extension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

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.

Short Extensões adicionais que não fazem parte do modelo de dados básicoAdditional 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.

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-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

Extensões adicionais que não fazem parte do modelo de dados básico

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

Short Extensões adicionais que não fazem parte do modelo de dados básicoExtensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

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 Names extensions, user content

18. Immunization.identifier

Definition

Identificadores externos para este recurso

A unique identifier assigned to this immunization record.

Short Identificadores externos para este recursoBusiness identifier

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Identifier

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. Immunization.status

Definition

O status do evento de administração de imunobiológico

Indicates the current status of the immunization event.

Short O status do evento de administração de imunobiológicocompleted | 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.

Control 1..1

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

code

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. Immunization.statusReason

Definition

O motivo pelo qual o imunobiológico não foi administrado

Indicates the reason the immunization event was not performed.

Short O motivo pelo qual o imunobiológico não foi administradoReason 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.

Control 0..01

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

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

24. Immunization.vaccineCode

Definition

Imunobiológico administrado

Vaccine that was administered or was to be administered.

Short Imunobiológico administradoVaccine product administered

Control 1..1

Binding The codes SHALL be taken from For example codes, see Imunobiológicohttp://hl7.org/fhir/ValueSet/vaccine-code
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. Immunization.patient

Definition

O paciente que recebeu o imunobiológico

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

Short O paciente que recebeu o imunobiológicoWho was immunized

Control 1..1

Type Reference(BRCorePatient, Patient)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. Immunization.patient.id

Definition

Identificador único para referenciação cruzada

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

Short Identificador único para referenciação cruzadaUnique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

30. Immunization.patient.extension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

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.

Short Extensões adicionais que não fazem parte do modelo de dados básicoAdditional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Slicing

This 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

32. Immunization.patient.reference

Definition

Referência literal,relativa, interna ou externa ou URL

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.

Short Referência literal,relativa, interna ou externa ou URLLiteral 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.

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

34. Immunization.patient.type

Definition

O tipo de referência utilizada

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

Short O tipo de referência utilizadaType 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.

Control 0..1

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

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

uri

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. Immunization.patient.identifier

Definition

Referência lógica,quando a referência literal não é conhecida

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.

Short Referência lógica,quando a referência literal não é conhecidaLogical 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).

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Identifier

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. Immunization.patient.display

Definition

Texto alternativo para o recurso

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

Short Texto alternativo para o recursoText 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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

40. Immunization.encounter

Definition

Referência ao atendimento no qual o imunobiológico foi administrado

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

Short Referência ao atendimento no qual o imunobiológico foi administradoEncounter immunization was part of

Control 0..01

Type Reference(br-core-encounter, Encounter)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

42. Immunization.occurrence[x]

Definition

Data em que o imunobiológico foi administrado

Date vaccine administered or was to be administered.

Short Data em que o imunobiológico foi administradoVaccine 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.

Control 1..1

Type Choice of: dateTime, string

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

44. Immunization.recorded

Definition

Data em que o primeiro registro de vacinação foi feito

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

Short Data em que o primeiro registro de vacinação foi feitoWhen the immunization was first captured in the subject's record

Control 0..01

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. Immunization.primarySource

Definition

Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúde

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.

Short Indica se o registro de vacinação foi relatado pelo paciente ou por um profissional de saúdeIndicates context the data was recorded in

Comments

Reflects the “reliability” of the content.

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. Immunization.reportOrigin

Definition

Indica a fonte do registro de vacinação relatado

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

Short Indica a fonte do registro de vacinação relatadoIndicates the source of a secondarily reported record

Comments

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

Control 0..1

Binding The codes SHALL be taken from For example codes, see Registro de Origemhttp://hl7.org/fhir/ValueSet/immunization-origin
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. Immunization.location

Definition

Local onde o imunobiológico foi administrado

The service delivery location where the vaccine administration occurred.

Short Local onde o imunobiológico foi administradoWhere immunization occurred

Control 0..1

Type Reference(br-core-location, Location)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. Immunization.manufacturer

Definition

Fabricante do imunobiológico

Name of vaccine manufacturer.

Short Fabricante do imunobiológicoVaccine manufacturer

Control 0..1

Type Reference(BRCoreOrganization, Organization)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Immunization.lotNumber

Definition

Número do lote do imunobiológico

Lot number of the vaccine product.

Short Número do lote do imunobiológicoVaccine lot number

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. Immunization.expirationDate

Definition

Data de validade do imunobiológico

Date vaccine batch expires.

Short Data de validade do imunobiológicoVaccine expiration date

Control 0..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. Immunization.site

Definition

Local de administração do imunobiológico

Body site where vaccine was administered.

Short Local de administração do imunobiológicoBody site vaccine was administered

Control 10..1

Binding The codes SHALL be taken from For example codes, see Local de Aplicaçãohttp://hl7.org/fhir/ValueSet/immunization-site
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. Immunization.route

Definition

Via de administração do imunobiológico

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

Short Via de administração do imunobiológicoHow vaccine entered body

Control 10..1

Binding The codes SHALL be taken from For example codes, see Via de Administração do Imunobiológicohttp://hl7.org/fhir/ValueSet/immunization-route
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. Immunization.doseQuantity

Definition

Quantidade de imunobiológico administrado

The quantity of vaccine product that was administered.

Short Quantidade de imunobiológico administradoAmount of vaccine administered

Control 0..1

Type Quantity(SimpleQuantity)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. Immunization.performer

Definition

Profissional de saúde que administrou o imunobiológico

Indicates who performed the immunization event.

Short Profissional de saúde que administrou o imunobiológicoWho performed event

Control 10..1*

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. Immunization.performer.id

Definition

Identificador único para referenciação cruzada

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

Short Identificador único para referenciação cruzadaUnique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

68. Immunization.performer.extension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

Short Extensões adicionais que não fazem parte do modelo de dados básicoAdditional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

70. Immunization.performer.modifierExtension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

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

Short Extensões adicionais que não fazem parte do modelo de dados básicoExtensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

72. Immunization.performer.function

Definition

Função do profissional de saúde no evento de administração de imunobiológico

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

Short Função do profissional de saúde no evento de administração de imunobiológicoWhat type of performance was done

Control 10..1

Binding The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Classificação Brasileira de Ocupações (CBO)http://hl7.org/fhir/ValueSet/immunization-function
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. Immunization.performer.actor

Definition

Profissional de saúde que administrou o imunobiológico

The practitioner or organization who performed the action.

Short Profissional de saúde que administrou o imunobiológicoIndividual or organization who was performing

Comments

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

Control 1..1

Type Reference(BRCorePractitioner, BRCorePractitionerRole, BRCoreOrganization, Practitioner, PractitionerRole, Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

76. Immunization.note

Definition

Observações adicionais sobre o evento de administração de imunobiológico

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

Short Observações adicionais sobre o evento de administração de imunobiológicoAdditional immunization notes

Control 0..0*

Annotation

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. Immunization.reasonCode

Definition

Motivo pelo qual o imunobiológico foi administrado

Reasons why the vaccine was administered.

Short Motivo pelo qual o imunobiológico foi administradoWhy immunization occurred

Control 0..1*

Binding The codes SHALL be taken from For example codes, see Estratégia de Vacinaçãohttp://hl7.org/fhir/ValueSet/immunization-reason
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BREstrategiaVacinacao)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. Immunization.reasonReference

Definition

Referência ao motivo pelo qual o imunobiológico foi administrado

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

Short Referência ao motivo pelo qual o imunobiológico foi administradoWhy immunization occurred

Control 0..1*

Type Reference(BRCoreCondition, BRCoreObservation, BRCoreDiagnosticReport, Condition, Observation, DiagnosticReport)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

82. Immunization.isSubpotent

Definition

Indica se o imunobiológico foi administrado em uma dose menor que a recomendada

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

Short Indica se o imunobiológico foi administrado em uma dose menor que a recomendadaDose 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.

Control 0..01

boolean

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Meaning if Missing By default, a dose should be considered to be potent.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Immunization.subpotentReason

Definition

Reason why a dose is considered to be subpotent.

Short Reason for being subpotent

Control 0..0*

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

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. Immunization.education

Definition

Informações sobre a educação do paciente sobre o imunobiológico

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

Short Informações sobre a educação do paciente sobre o imunobiológicoEducational material presented to patient

Control 0..0*

Is Modifier false

Summary false

Invariants ele-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())

95. Immunization.programEligibility

Definition

Informações sobre a elegibilidade do paciente para o programa de imunização

Indicates a patient's eligibility for a funding program.

Short Informações sobre a elegibilidade do paciente para o programa de imunizaçãoPatient eligibility for a vaccination program

Control 0..0*

Binding The codes SHALL be taken from For example codes, see https://terminologia.saude.gov.br/fhir/ValueSet/BRElegibilidadeImunobiologicohttp://hl7.org/fhir/ValueSet/immunization-program-eligibility
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRElegibilidadeImunobiologico)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

97. Immunization.fundingSource

Definition

Fonte de financiamento do imunobiológico

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

Short Fonte de financiamento do imunobiológicoFunding source for the vaccine

Control 0..01

Binding The codes SHALL be taken from For example codes, see ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source
(required to http://hl7.org/fhir/ValueSet/immunization-funding-source)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

99. Immunization.reaction

Definition

Reações adversas do paciente ao imunobiológico

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

Short Reações adversas do paciente ao imunobiológicoDetails 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.

Control 0..0*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

107. Immunization.protocolApplied

Definition

Protocolos aplicados durante a administração do imunobiológico

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

Short Protocolos aplicados durante a administração do imunobiológicoProtocol followed by the provider

Control 10..1*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

109. Immunization.protocolApplied.id

Definition

Identificador único para referenciação cruzada

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

Short Identificador único para referenciação cruzadaUnique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

111. Immunization.protocolApplied.extension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

Short Extensões adicionais que não fazem parte do modelo de dados básicoAdditional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Slicing

This element introduces a set of slices on Immunization.protocolApplied.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

113. Immunization.protocolApplied.extension:pesquisaClinica

Slice Name pesquisaClinica

Definition

Pesquisa clínica

Short Pesquisa clínica

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Extensão de pesquisa clínica do Core do Brasil) (Complex Extension)

Is Modifier false

Invariants ele-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())

115. Immunization.protocolApplied.modifierExtension

Definition

Extensões adicionais que não fazem parte do modelo de dados básico

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

Short Extensões adicionais que não fazem parte do modelo de dados básicoExtensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

117. Immunization.protocolApplied.series

Definition

Nome da série do imunobiológico

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

Short Nome da série do imunobiológicoName of vaccine series

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

119. Immunization.protocolApplied.authority

Definition

Autoridade que definiu o protocolo de administração do imunobiológico

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

Short Autoridade que definiu o protocoloWho is responsible for publishing the recommendations

Control 0..01

Type Reference(BRCoreOrganization, Organization)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

121. Immunization.protocolApplied.targetDisease

Definition

Doença alvo do imunobiológico

The vaccine preventable disease the dose is being administered against.

Short Doença alvo do imunobiológicoVaccine preventatable disease being targetted

Control 0..*

Binding The codes SHOULD be taken from For example codes, see Classificação Internacional de Doenças - Décima Revisão - CID-10http://hl7.org/fhir/ValueSet/immunization-target-disease
(preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

123. Immunization.protocolApplied.doseNumber[x]

Definition

Número da dose do imunobiológico

Nominal position in a series.

Short Número da dose do imunobiológicoDose 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).

Control 1..1

Binding The codes SHALL be taken from For codes, see Dose do Imunobiológico
(required to https://terminologia.saude.gov.br/fhir/ValueSet/BRDose)

Type string, positiveInt

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

125. Immunization.protocolApplied.seriesDoses[x]

Definition

Número de doses da série do imunobiológico

The recommended number of doses to achieve immunity.

Short Número de doses da série do imunobiológicoRecommended 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).

Control 0..1

Type Choice of: positiveInt, string

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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.

Short Immunization event information

Control 0..*

Is Modifier false

Summary false

Invariants dom-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

ID lógico deste artefato

Short ID lógico deste artefato

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.

Control 0..1

Is Modifier false

Summary true

4. Immunization.meta

Definition

Metadados sobre o recurso

Short Metadados sobre o recurso

Control 0..1