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

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

Resource Profile: Administração de Imunobiológicos em Crianças e Pré-Adolescentes em Goiás

Official URL: https://fhir.saude.go.gov.br/r4/core/StructureDefinition/imunobiologico-administrado Version: 0.0.1
Active as of 2024-04-15 Computable Name: ImunobiologicoAdministrado

Perfil para representar um imunobiológico administrado.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 Indica o status atual da administração do Imunobiológico.
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
Required Pattern: completed
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..0
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
ele-1: All FHIR elements must have a @value or children
.... extension 0..0
... occurrence[x] Σ 1..1 dateTime Data de administração da vacina
ele-1: All FHIR elements must have a @value or children
... lotNumber 0..1 string Número do lote da vacina
ele-1: All FHIR elements must have a @value or children
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
ele-1: All FHIR elements must have a @value or children
.... doseNumber[x] 1..1 string Número da dose dentro da série
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.statusrequiredPattern: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... identifier 0..0
... status 1..1 code Indica o status atual da administração do Imunobiológico.
Required Pattern: completed
.... id 0..0
.... extension 0..0
... statusReason 0..0
... vaccineCode 1..1 CodeableConcept Produto da vacina administrada
Binding: Imunobiológico (required)
.... id 0..0
.... extension 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... id 0..0
..... extension 0..0
..... system 1..1 uri Identity of the terminology system
...... id 0..0
...... extension 0..0
..... version 0..0
..... code 1..1 code Symbol in syntax defined by the system
...... id 0..0
...... extension 0..0
..... display 0..0
..... userSelected 0..0
.... text 0..0
... patient 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
.... id 0..0
.... extension 0..0
... encounter 0..0
... occurrence[x] 1..1 dateTime Data de administração da vacina
.... id 0..0
.... extension 0..0
... recorded 0..0
... primarySource 0..0
... reportOrigin 0..0
... location 0..0
... manufacturer 0..0
... lotNumber 0..1 string Número do lote da vacina
.... id 0..0
.... extension 0..0
... expirationDate 0..0
... site 0..0
... route 0..0
... doseQuantity 0..0
... performer 0..0
... note 0..0
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 string Número da dose dentro da série
..... id 0..0
..... extension 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... status ?!Σ 1..1 code Indica o status atual da administração do Imunobiológico.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Required Pattern: completed
.... value 0..1 string Primitive value for code
... vaccineCode Σ 1..1 CodeableConcept Produto da vacina administrada
Binding: Imunobiológico (required)
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system Σ 1..1 uri Identity of the terminology system
...... value 0..1 uri Primitive value for uri
..... code Σ 1..1 code Symbol in syntax defined by the system
...... value 0..1 string Primitive value for code
... patient Σ 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
.... extension 0..0
.... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] Σ 1..1 dateTime Data de administração da vacina
.... value 0..1 dateTime Primitive value for dateTime
... lotNumber 0..1 string Número do lote da vacina
.... value 0..1 string Primitive value for string
Max Length:1048576
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
.... doseNumber[x] 1..1 string Número da dose dentro da série
..... value 0..1 string Primitive value for string
Max Length:1048576
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredPattern: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Mandatory: 4 elements
Prohibited: 50 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 Indica o status atual da administração do Imunobiológico.
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
Required Pattern: completed
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... extension 0..0
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
ele-1: All FHIR elements must have a @value or children
.... extension 0..0
... occurrence[x] Σ 1..1 dateTime Data de administração da vacina
ele-1: All FHIR elements must have a @value or children
... lotNumber 0..1 string Número do lote da vacina
ele-1: All FHIR elements must have a @value or children
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
ele-1: All FHIR elements must have a @value or children
.... doseNumber[x] 1..1 string Número da dose dentro da série
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.statusrequiredPattern: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... identifier 0..0
... status 1..1 code Indica o status atual da administração do Imunobiológico.
Required Pattern: completed
.... id 0..0
.... extension 0..0
... statusReason 0..0
... vaccineCode 1..1 CodeableConcept Produto da vacina administrada
Binding: Imunobiológico (required)
.... id 0..0
.... extension 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... id 0..0
..... extension 0..0
..... system 1..1 uri Identity of the terminology system
...... id 0..0
...... extension 0..0
..... version 0..0
..... code 1..1 code Symbol in syntax defined by the system
...... id 0..0
...... extension 0..0
..... display 0..0
..... userSelected 0..0
.... text 0..0
... patient 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
.... id 0..0
.... extension 0..0
... encounter 0..0
... occurrence[x] 1..1 dateTime Data de administração da vacina
.... id 0..0
.... extension 0..0
... recorded 0..0
... primarySource 0..0
... reportOrigin 0..0
... location 0..0
... manufacturer 0..0
... lotNumber 0..1 string Número do lote da vacina
.... id 0..0
.... extension 0..0
... expirationDate 0..0
... site 0..0
... route 0..0
... doseQuantity 0..0
... performer 0..0
... note 0..0
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 string Número da dose dentro da série
..... id 0..0
..... extension 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... status ?!Σ 1..1 code Indica o status atual da administração do Imunobiológico.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Required Pattern: completed
.... value 0..1 string Primitive value for code
... vaccineCode Σ 1..1 CodeableConcept Produto da vacina administrada
Binding: Imunobiológico (required)
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system Σ 1..1 uri Identity of the terminology system
...... value 0..1 uri Primitive value for uri
..... code Σ 1..1 code Symbol in syntax defined by the system
...... value 0..1 string Primitive value for code
... patient Σ 1..1 Reference(Indivíduo) Para quem esta imunização foi administrada
.... extension 0..0
.... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] Σ 1..1 dateTime Data de administração da vacina
.... value 0..1 dateTime Primitive value for dateTime
... lotNumber 0..1 string Número do lote da vacina
.... value 0..1 string Primitive value for string
Max Length:1048576
... protocolApplied 1..1 BackboneElement Protocolo seguido pelo provedor
.... doseNumber[x] 1..1 string Número da dose dentro da série
..... value 0..1 string Primitive value for string
Max Length:1048576
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredPattern: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.vaccineCoderequiredImunobiológico
http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0
Immunization.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Mandatory: 4 elements
Prohibited: 50 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron