Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS
0.1.0 - STU1
Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS
0.1.0 - STU1
Guia de Implementação do Registro de Imunobiológico Administrado (RIA) da RNDS - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRImunobiologicoAdministradoCampanha-2.0 | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: BRImunobiologicoAdministradoCampanha | ||
Representa um imunobiológico administrado em campanha vacinal (Portaria Conjunta SAES/SVSA/SEIDIGI Nº 25, de 27 de Novembro de 2023).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization |
S | 0..* | Immunization | Imunobiológico administrado em campanha |
  extension |
2..2 | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |
 extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal |
 identifier |
0..0 | |||
| status |
S | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed |
| statusReason |
0..0 | |||
| vaccineCode |
S | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
0..0 | |||
 userSelected |
0..0 | |||
| text |
0..0 | |||
 patient |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. |
| reference |
0..0 | |||
| type |
0..0 | |||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| use |
0..0 | |||
| type |
0..0 | |||
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| encounter |
0..0 | |||
 occurrence[x] |
S | 1..1 | dateTime | Data da Administração do Imunobiológico |
| recorded |
0..0 | |||
| primarySource |
0..0 | |||
| reportOrigin |
0..0 | |||
| location |
0..0 | |||
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante |
| reference |
0..0 | |||
| type |
0..0 | |||
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use |
0..0 | |||
| type |
0..0 | |||
| system |
S | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI |
| value |
S | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| lotNumber |
S | 1..1 | string | Lote |
| expirationDate |
0..0 | |||
| site |
S | 0..0 | ||
| route |
S | 0..0 | ||
| doseQuantity |
0..0 | |||
| performer |
S | 1..1 | BackboneElement | Profissional executante |
| function |
0..0 | |||
 actor |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante |
 reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
0..0 | |||
| identifier |
0..0 | |||
| display |
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 |
S | 1..1 | BackboneElement | Protocol followed by the provider |
| series |
0..0 | |||
| authority |
0..0 | |||
| targetDisease |
0..0 | |||
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico |
| seriesDoses[x] |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | |
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | |
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | |
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
S | 0..* | Immunization | Imunobiológico administrado em campanha |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |
| extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed |
 vaccineCode |
SΣ | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| patient |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| occurrence[x] |
SΣ | 1..1 | dateTime | Data da Administração do Imunobiológico |
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
SΣ | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI |
| value |
SΣ | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. Example General: 123456 |
| lotNumber |
S | 1..1 | string | Lote |
| performer |
SΣ | 1..1 | BackboneElement | Profissional executante |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| protocolApplied |
S | 1..1 | BackboneElement | Protocol followed by the provider |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | |
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | |
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | |
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
| 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 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 |
S | 0..* | Immunization | Imunobiológico administrado em campanha | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |||||
| extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed | ||||
| vaccineCode |
SΣ | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| patient |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| occurrence[x] |
SΣ | 1..1 | dateTime | Data da Administração do Imunobiológico | ||||
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier |
SΣ | 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 | |||||
| system |
SΣ | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI | ||||
| value |
SΣ | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. Example General: 123456 | ||||
| lotNumber |
S | 1..1 | string | Lote | ||||
| performer |
SΣ | 1..1 | BackboneElement | Profissional executante | ||||
| 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 | ||||
| actor |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante | ||||
| 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 | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| protocolApplied |
S | 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 | ||||
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | ||||
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | ||||
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | ||||
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
| 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 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() |
This structure is derived from Immunization
Summary
Mandatory: 12 elements(12 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements
Prohibited: 62 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
S | 0..* | Immunization | Imunobiológico administrado em campanha |
| extension |
2..2 | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |
| extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal |
| identifier |
0..0 | |||
| status |
S | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed |
| statusReason |
0..0 | |||
| vaccineCode |
S | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
0..0 | |||
| userSelected |
0..0 | |||
| text |
0..0 | |||
| patient |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. |
| reference |
0..0 | |||
| type |
0..0 | |||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| use |
0..0 | |||
| type |
0..0 | |||
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| encounter |
0..0 | |||
| occurrence[x] |
S | 1..1 | dateTime | Data da Administração do Imunobiológico |
| recorded |
0..0 | |||
| primarySource |
0..0 | |||
| reportOrigin |
0..0 | |||
| location |
0..0 | |||
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante |
| reference |
0..0 | |||
| type |
0..0 | |||
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use |
0..0 | |||
| type |
0..0 | |||
| system |
S | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI |
| value |
S | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| lotNumber |
S | 1..1 | string | Lote |
| expirationDate |
0..0 | |||
| site |
S | 0..0 | ||
| route |
S | 0..0 | ||
| doseQuantity |
0..0 | |||
| performer |
S | 1..1 | BackboneElement | Profissional executante |
| function |
0..0 | |||
| actor |
S | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
0..0 | |||
| identifier |
0..0 | |||
| display |
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 |
S | 1..1 | BackboneElement | Protocol followed by the provider |
| series |
0..0 | |||
| authority |
0..0 | |||
| targetDisease |
0..0 | |||
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico |
| seriesDoses[x] |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | |
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | |
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | |
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
S | 0..* | Immunization | Imunobiológico administrado em campanha |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |
| extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed |
| vaccineCode |
SΣ | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| patient |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| occurrence[x] |
SΣ | 1..1 | dateTime | Data da Administração do Imunobiológico |
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
SΣ | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI |
| value |
SΣ | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. Example General: 123456 |
| lotNumber |
S | 1..1 | string | Lote |
| performer |
SΣ | 1..1 | BackboneElement | Profissional executante |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| protocolApplied |
S | 1..1 | BackboneElement | Protocol followed by the provider |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | |
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | |
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | |
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
| 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 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
S | 0..* | Immunization | Imunobiológico administrado em campanha | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:grupoAtendimento |
1..1 | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRGrupoAtendimento | |||||
| extension:condicaoMaternal |
S | 1..* | ?gen-e1? [CanonicalType[http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal]] | Extension URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRCondicaoMaternal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | Estado da Administração do Imunobiológico Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 (required): Estado do evento Fixed Value: completed | ||||
| vaccineCode |
SΣ | 1..1 | CodeableConcept | Imunobiológico administrado em campanha vacinal. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 (required): Imunobiológico. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| patient |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0) | indivíduo imunizado. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| occurrence[x] |
SΣ | 1..1 | dateTime | Data da Administração do Imunobiológico | ||||
| manufacturer |
S | 0..1 | Reference(Organization) | Fabricante | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier |
SΣ | 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 | |||||
| system |
SΣ | 1..1 | uri | Fabricante PNI Fixed Value: http://www.saude.gov.br/fhir/r4/CodeSystem/BRFabricantePNI | ||||
| value |
SΣ | 1..1 | string | Fabricante do imunobiológico. Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 (required): O código do fabricante do imunobiológico. Example General: 123456 | ||||
| lotNumber |
S | 1..1 | string | Lote | ||||
| performer |
SΣ | 1..1 | BackboneElement | Profissional executante | ||||
| 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 | ||||
| actor |
SΣ | 1..1 | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRProfissional-1.0) | Profissional executante | ||||
| 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 | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| protocolApplied |
S | 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 | ||||
| doseNumber[x] |
S | 1..1 | string | Dose Binding: http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 (required): Dose do Imunobiológico | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | Fixed Value: completedhttp://www.saude.gov.br/fhir/r4/ValueSet/BREstadoEvento-1.0 | ||||
| Immunization.vaccineCode | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRImunobiologico-1.0 | ||||
| Immunization.manufacturer.identifier.value | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRFabricanteImunobiologico-1.0 | ||||
| Immunization.protocolApplied.doseNumber[x] | required | http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0http://www.saude.gov.br/fhir/r4/ValueSet/BRDose-1.0 |
| 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 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() |
This structure is derived from Immunization
Summary
Mandatory: 12 elements(12 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements
Prohibited: 62 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron