Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	Σ	1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante. ele-1: All FHIR elements must have a @value or children
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrence[x]:occurrenceDateTime	ΣC	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children DataComPrecisaoDeDia: Data deve ter a precisão de dia
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
protocolApplied		1..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
vaccineCode		1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required)
patient		1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante.
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value		1..1	string	The value that is unique
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of
Slices for occurrence[x]		1..1	dateTime	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	C	1..1	dateTime	Vaccine administration date DataComPrecisaoDeDia: Data deve ter a precisão de dia
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
DataComPrecisaoDeDia	error	Immunization.occurrence[x]:occurrenceDateTime	Data deve ter a precisão de dia : $this.toString().length() = 10

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required)
patient	Σ	1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	ΣC	1..1	dateTime	Vaccine administration date DataComPrecisaoDeDia: Data deve ter a precisão de dia
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required)
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

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

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

• Indivíduo (https://fhir.saude.go.gov.br/r4/core/StructureDefinition/individuo)
• Consulta acompanhamento gestante (https://fhir.saude.go.gov.br/r4/core/StructureDefinition/consulta-acompanhamento-gestante)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.occurrence[x]

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	Σ	1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante. ele-1: All FHIR elements must have a @value or children
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrence[x]:occurrenceDateTime	ΣC	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children DataComPrecisaoDeDia: Data deve ter a precisão de dia
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
protocolApplied		1..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
vaccineCode		1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required)
patient		1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante.
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value		1..1	string	The value that is unique
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of
Slices for occurrence[x]		1..1	dateTime	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	C	1..1	dateTime	Vaccine administration date DataComPrecisaoDeDia: Data deve ter a precisão de dia
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
DataComPrecisaoDeDia	error	Immunization.occurrence[x]:occurrenceDateTime	Data deve ter a precisão de dia : $this.toString().length() = 10

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Imunobiológico Binding: Imunização gestante (required)
patient	Σ	1..1	Reference(Indivíduo)	Identificador nacional da cidadã/gestante.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.saude.go.gov.br/sid/cpf
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
encounter		1..1	Reference(Consulta acompanhamento gestante)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	ΣC	1..1	dateTime	Vaccine administration date DataComPrecisaoDeDia: Data deve ter a precisão de dia
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1	string	Dose do imunobiológico Binding: Dose Administrada Gestante (required)
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	required	ImunizacaoGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/imunizacao-gestante from this IG
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard
Immunization.protocolApplied.doseNumber[x]	required	DoseAdministradaGestante https://fhir.saude.go.gov.br/r4/core/ValueSet/dose-administrada-gestante from this IG

Constraints

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

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

• Indivíduo (https://fhir.saude.go.gov.br/r4/core/StructureDefinition/individuo)
• Consulta acompanhamento gestante (https://fhir.saude.go.gov.br/r4/core/StructureDefinition/consulta-acompanhamento-gestante)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.occurrence[x]