Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Immunization

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
occurrence[x]		1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource		1..1	boolean	Indicates context the data was recorded in
site		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): x
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
occurrence[x]	Σ	1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	1..1	boolean	Indicates context the data was recorded in
site		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.status	required	ImmunizationStatusCodes
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)

Constraints

Id	Grade	Path(s)	Details	Requirements
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.exists() and ('#'+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(uri) = '#').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
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): IETF language tag 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): x
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): x
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	Σ	1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	1..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): x
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		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
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): x
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): x
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
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): x
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): x
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..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): x
doseNumber[x]		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)
Immunization.performer.function	extensible	ImmunizationFunctionCodes
Immunization.reasonCode	example	ImmunizationReasonCodes
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	Immunization.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from Immunization

Summary

Mandatory: 5 elements

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
occurrence[x]		1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource		1..1	boolean	Indicates context the data was recorded in
site		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): x
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
occurrence[x]	Σ	1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	1..1	boolean	Indicates context the data was recorded in
site		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.status	required	ImmunizationStatusCodes
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)

Constraints

Id	Grade	Path(s)	Details	Requirements
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.exists() and ('#'+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(uri) = '#').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()

Snapshot View

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): IETF language tag 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): x
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): x
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineCode (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	Σ	1..1	dateTime	Vaccine administration date
recorded		1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	1..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): x
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		1..1	CodeableConcept	Body site vaccine was administered Binding: VaccineBodySite (required)
route		1..1	CodeableConcept	How vaccine entered body Binding: VaccineRoute (example)
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): x
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): x
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
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): x
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): x
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..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): x
doseNumber[x]		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	required	VaccineCode (a valid code from BRImunobiologico)
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.site	required	VaccineBodySite (a valid code from BRLocalAplicacao)
Immunization.route	example	VaccineRoute (a valid code from BRViaAdministracao)
Immunization.performer.function	extensible	ImmunizationFunctionCodes
Immunization.reasonCode	example	ImmunizationReasonCodes
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	Immunization.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from Immunization

Summary

Mandatory: 5 elements

Other representations of profile: CSV, Excel, Schematron