Guia de Implementação da iPES - CI build
0.1.0 - ci-build

!!Guia de Implementação da iPES - CI build - Compilação de desenvolvimento local (v0.1.0) construída pelas ferramentas de compilação FHIR (HL7® FHIR® Standard). Veja o Diretório de versões publicadas

Resource Profile: Imunização

Official URL: https://fhir.ipes.tech/fhir/StructureDefinition/ImmunizationBRIPES Version: 0.1.0
Draft as of 2025-07-02 Computable Name: ImmunizationBRIPES

Registro de imunização

Perfil FHIR: IPES-ImmunizationBRIPES

Identificação

  • ID: IPES-Immunization
  • Versão: 1.0.6
  • URL: https://fhir.ipes.tech/StructureDefinition/ImmunizationBRIPES
  • Base: http://hl7.org/fhir/StructureDefinition/Immunization
  • Status: Active
  • Data: 2025-06-27
  • Publicador: Instituto de Plataformas Eletrônicas de Saúde (iPES)

Descrição

Este perfil define como registrar imunizações na plataforma iPES. Ele utiliza terminologias brasileiras oficiais e referências ao perfil BR-Core Location para o local físico da vacinação. O location refere-se a qualquer local onde a vacinação foi realizada, como unidades básicas de saúde (UBS), campanhas móveis, ou atendimento domiciliar.

Elementos definidos

Caminho Obrigatório Tipo Binding / Descrição
status Sim code ValueSet immunization-status
vaccineCode Sim CodeableConcept ValueSet BRImunobiologico
patient Sim Reference(Patient) Paciente vacinado
occurrenceDateTime Sim dateTime Data e hora da aplicação
text Sim Narrative Narrativa legível
route Opcional CodeableConcept ValueSet BRViaAdministracao
site Opcional CodeableConcept ValueSet BRLocalAplicacao
location Opcional Reference(Location) Local físico conforme perfil BR-Core Location
manufacturer Opcional CodeableConcept CodeSystem BRFabricantePNI
lotNumber Opcional string Lote do imunobiológico
performer Opcional BackboneElement Profissional aplicador

Regras de uso

  • status, vaccineCode, patient, occurrenceDateTime, e text são obrigatórios.
  • Campos como site, route, manufacturer e location são opcionais, mas recomendados para interoperabilidade.
  • O campo location deve ser usado com o perfil BR-Core Location para representar qualquer tipo de local de aplicação.

Referências

  • ValueSet:
    • https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
    • https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
    • https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
  • CodeSystem:
    • https://terminologia.saude.gov.br/fhir/CodeSystem/BRFabricantePNI
  • Perfil de Local:
    • https://br-core-ig.web.app/StructureDefinition-br-core-location

Usos:

  • Este Perfil não é utilizado por nenhum perfil neste guia de implementação

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier Σ 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value Σ 1..1 string CNS do profissional
Exemplo General: 123456
...... identifier:cpf Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value Σ 1..1 string CPF do profissional
Exemplo General: 123456
...... identifier:registroProfissional Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value Σ 1..1 string Número do registro
Exemplo General: 123456
.... contained:organizationContained 0..1 Organization Organização
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier ΣC 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes ΣC 0..1 Identifier Identifies this organization across multiple systems
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value Σ 1..1 string CNES da organização
Exemplo General: 123456
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... system Σ 1..1 uri Identificador único do sistema de origem
Exemplo General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identificador do registro no sistema de origem
Exemplo General: 123456
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico (preferred)
... patient Σ 1..1 Reference(Paciente) Who was immunized
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... Fatias para performer Σ 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:practitioner Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference ΣC 0..1 string Profissional aplicador
.... performer:practitionerContained Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
.... performer:organization Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... reference ΣC 0..1 string Organização aplicadora
.... performer:organizationContained Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
... protocolApplied 0..1 BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.contained:practititonerContained.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From a norma FHIR
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... meta 0..0
..... implicitRules 0..0
..... language 0..0
..... text 0..0
..... contained 0..0
..... Fatias para identifier 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value 1..1 string CNS do profissional
....... period 0..0
....... assigner 0..0
...... identifier:cpf 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value 1..1 string CPF do profissional
....... period 0..0
....... assigner 0..0
...... identifier:registroProfissional 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value 1..1 string Número do registro
....... period 0..0
....... assigner
........ display 1..1 string Text alternative for the resource
..... active 0..0
..... telecom 0..0
..... address 0..0
..... gender 0..0
..... birthDate 0..0
..... photo 0..0
..... qualification 0..0
..... communication 0..0
.... contained:organizationContained 0..1 Organization Organização
..... meta 0..0
..... implicitRules 0..0
..... language 0..0
..... text 0..0
..... contained 0..0
..... Fatias para identifier 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes 0..1 Identifier Identifies this organization across multiple systems
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value 1..1 string CNES da organização
....... period 0..0
....... assigner 0..0
..... active 0..0
..... type 0..0
..... telecom 0..0
..... address 0..0
..... partOf 0..0
..... contact 0..0
..... endpoint 0..0
... Fatias para identifier 1..1 Identifier Business identifier
Fatia: Não ordenado, Aberto por pattern:system
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... use 0..0
..... type 0..0
..... system 1..1 uri Identificador único do sistema de origem
..... value 1..1 string Identificador do registro no sistema de origem
..... period 0..0
..... assigner 0..0
... statusReason 0..0
... patient 1..1 Reference(Paciente) Who was immunized
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded 0..0
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... location 0..0
... manufacturer
.... reference 0..0
.... type 0..0
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... doseQuantity 0..0
... Fatias para performer 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:practitioner 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference 0..1 string Profissional aplicador
...... type 0..0
...... identifier 0..0
...... display 0..0
.... performer:practitionerContained 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
...... type 0..0
...... identifier 0..0
.... performer:organization 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Organization) Individual or organization who was performing
...... reference 0..1 string Organização aplicadora
...... type 0..0
...... identifier 0..0
...... display 0..0
.... performer:organizationContained 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Organization) Individual or organization who was performing
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
...... type 0..0
...... identifier 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 0..1 BackboneElement Protocol followed by the provider
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)
.... seriesDoses[x] 0..0

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose
NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... id Σ 0..1 id Logical id of this artifact
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier Σ 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value Σ 1..1 string CNS do profissional
Exemplo General: 123456
...... identifier:cpf Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value Σ 1..1 string CPF do profissional
Exemplo General: 123456
...... identifier:registroProfissional Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value Σ 1..1 string Número do registro
Exemplo General: 123456
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por 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")
Vínculo: 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 Σ 1..1 string Text alternative for the resource
..... name Σ 0..* HumanName The name(s) associated with the practitioner
.... contained:organizationContained 0..1 Organization Organização
..... id Σ 0..1 id Logical id of this artifact
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier ΣC 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes ΣC 0..1 Identifier Identifies this organization across multiple systems
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value Σ 1..1 string CNES da organização
Exemplo General: 123456
..... name ΣC 0..1 string Name used for the organization
..... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Fatias para identifier 1..1 Identifier Business identifier
Fatia: Não ordenado, Aberto por pattern:system
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
..... system Σ 1..1 uri Identificador único do sistema de origem
Exemplo General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identificador do registro no sistema de origem
Exemplo General: 123456
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico (preferred)
... patient Σ 1..1 Reference(Paciente) Who was immunized
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... Fatias para performer Σ 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... 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
Vínculo: 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
.... performer:practitioner Σ 0..1 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
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 0..1 string Profissional aplicador
.... performer:practitionerContained Σ 0..1 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
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
...... display Σ 0..1 string Text alternative for the resource
.... performer:organization Σ 0..1 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
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 0..1 string Organização aplicadora
.... performer:organizationContained Σ 0..1 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
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
...... display Σ 0..1 string Text alternative for the resource
... note Σ 0..* Annotation Additional immunization notes
... protocolApplied 0..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] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.contained:practititonerContained.identifier:registroProfissional.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.contained:practititonerContained.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From a norma FHIR
Immunization.contained:organizationContained.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From a norma FHIR
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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

Resumo

Obrigatório: 5 elementos(11 aninhado obrigatoriamente elementos)
Fixo: 6 elementos
Proibido: 79 elementos

Estruturas

Esta estrutura refere-se a estas outras estruturas:

Fatias

Esta estrutura define os seguintes Slices:

  • The element 1 is sliced based on the value of Immunization.contained
  • The element 1 is sliced based on the value of Immunization.contained.identifier
  • The element 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.performer

Key Elements View

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier Σ 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value Σ 1..1 string CNS do profissional
Exemplo General: 123456
...... identifier:cpf Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value Σ 1..1 string CPF do profissional
Exemplo General: 123456
...... identifier:registroProfissional Σ 0..1 Identifier An identifier for the person as this agent
....... system Σ 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value Σ 1..1 string Número do registro
Exemplo General: 123456
.... contained:organizationContained 0..1 Organization Organização
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier ΣC 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes ΣC 0..1 Identifier Identifies this organization across multiple systems
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value Σ 1..1 string CNES da organização
Exemplo General: 123456
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... system Σ 1..1 uri Identificador único do sistema de origem
Exemplo General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identificador do registro no sistema de origem
Exemplo General: 123456
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico (preferred)
... patient Σ 1..1 Reference(Paciente) Who was immunized
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... Fatias para performer Σ 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
.... performer:practitioner Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference ΣC 0..1 string Profissional aplicador
.... performer:practitionerContained Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
.... performer:organization Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... reference ΣC 0..1 string Organização aplicadora
.... performer:organizationContained Σ 0..1 BackboneElement Who performed event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
... protocolApplied 0..1 BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.contained:practititonerContained.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From a norma FHIR
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... meta 0..0
..... implicitRules 0..0
..... language 0..0
..... text 0..0
..... contained 0..0
..... Fatias para identifier 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value 1..1 string CNS do profissional
....... period 0..0
....... assigner 0..0
...... identifier:cpf 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value 1..1 string CPF do profissional
....... period 0..0
....... assigner 0..0
...... identifier:registroProfissional 0..1 Identifier An identifier for the person as this agent
....... use 0..0
....... type 0..0
....... system 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value 1..1 string Número do registro
....... period 0..0
....... assigner
........ display 1..1 string Text alternative for the resource
..... active 0..0
..... telecom 0..0
..... address 0..0
..... gender 0..0
..... birthDate 0..0
..... photo 0..0
..... qualification 0..0
..... communication 0..0
.... contained:organizationContained 0..1 Organization Organização
..... meta 0..0
..... implicitRules 0..0
..... language 0..0
..... text 0..0
..... contained 0..0
..... Fatias para identifier 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes 0..1 Identifier Identifies this organization across multiple systems
....... use 0..0
....... type 0..0
....... system 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value 1..1 string CNES da organização
....... period 0..0
....... assigner 0..0
..... active 0..0
..... type 0..0
..... telecom 0..0
..... address 0..0
..... partOf 0..0
..... contact 0..0
..... endpoint 0..0
... Fatias para identifier 1..1 Identifier Business identifier
Fatia: Não ordenado, Aberto por pattern:system
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... use 0..0
..... type 0..0
..... system 1..1 uri Identificador único do sistema de origem
..... value 1..1 string Identificador do registro no sistema de origem
..... period 0..0
..... assigner 0..0
... statusReason 0..0
... patient 1..1 Reference(Paciente) Who was immunized
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded 0..0
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... location 0..0
... manufacturer
.... reference 0..0
.... type 0..0
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... doseQuantity 0..0
... Fatias para performer 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:practitioner 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference 0..1 string Profissional aplicador
...... type 0..0
...... identifier 0..0
...... display 0..0
.... performer:practitionerContained 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Practitioner) Individual or organization who was performing
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
...... type 0..0
...... identifier 0..0
.... performer:organization 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Organization) Individual or organization who was performing
...... reference 0..1 string Organização aplicadora
...... type 0..0
...... identifier 0..0
...... display 0..0
.... performer:organizationContained 0..1 BackboneElement Who performed event
..... function 0..0
..... actor 1..1 Reference(Organization) Individual or organization who was performing
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
...... type 0..0
...... identifier 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 0..1 BackboneElement Protocol followed by the provider
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)
.... seriesDoses[x] 0..0

doco Documentação para este formato

Terminologia Ligações (Diferencial)

CaminhoConformidadeConjunto de valoresURI
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose

Snapshot View

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Fatias para contained 0..1 Resource Contained, inline Resources
Fatia: Não ordenado, Aberto por pattern:$this
.... contained:practititonerContained 0..1 Practitioner Profissional
..... id Σ 0..1 id Logical id of this artifact
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier Σ 0..* Identifier An identifier for the person as this agent
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cns Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.236
....... value Σ 1..1 string CNS do profissional
Exemplo General: 123456
...... identifier:cpf Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.237
....... value Σ 1..1 string CPF do profissional
Exemplo General: 123456
...... identifier:registroProfissional Σ 0..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri Namespace para registros de identificação civil
Valor fixo: urn:oid:2.16.840.1.113883.13.243
....... value Σ 1..1 string Número do registro
Exemplo General: 123456
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por 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")
Vínculo: 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 Σ 1..1 string Text alternative for the resource
..... name Σ 0..* HumanName The name(s) associated with the practitioner
.... contained:organizationContained 0..1 Organization Organização
..... id Σ 0..1 id Logical id of this artifact
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... Fatias para identifier ΣC 0..* Identifier Identifies this organization across multiple systems
Fatia: Não ordenado, Aberto por pattern:$this
...... identifier:cnes ΣC 0..1 Identifier Identifies this organization across multiple systems
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
....... system Σ 1..1 uri The namespace for the identifier value
Valor fixo: urn:oid:2.16.840.1.113883.13.36
....... value Σ 1..1 string CNES da organização
Exemplo General: 123456
..... name ΣC 0..1 string Name used for the organization
..... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Fatias para identifier 1..1 Identifier Business identifier
Fatia: Não ordenado, Aberto por pattern:system
.... identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
..... system Σ 1..1 uri Identificador único do sistema de origem
Exemplo General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identificador do registro no sistema de origem
Exemplo General: 123456
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Vínculo: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico (preferred)
... patient Σ 1..1 Reference(Paciente) Who was immunized
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred)
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred)
... Fatias para performer Σ 0..* BackboneElement Who performed event
Fatia: Não ordenado, Aberto por pattern:$this
.... performer:Todas as fatias Conteúdo/regras para todas as fatias
..... 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
Vínculo: 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
.... performer:practitioner Σ 0..1 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
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 0..1 string Profissional aplicador
.... performer:practitionerContained Σ 0..1 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
..... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #practitioner
...... display Σ 0..1 string Text alternative for the resource
.... performer:organization Σ 0..1 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
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 0..1 string Organização aplicadora
.... performer:organizationContained Σ 0..1 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
..... actor Σ 1..1 Reference(Organization) Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Fatia: Não ordenado, Aberto por value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
Valor fixo: #organization
...... display Σ 0..1 string Text alternative for the resource
... note Σ 0..* Annotation Additional immunization notes
... protocolApplied 0..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] 1..1 string Dose number within series
Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred)

doco Documentação para este formato

Terminologia Ligações

CaminhoConformidadeConjunto de valoresURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From a norma FHIR
Vínculos adicionais Objetivo
AllLanguages Vínculo máximo
Immunization.contained:practititonerContained.identifier:registroProfissional.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From a norma FHIR
Immunization.contained:practititonerContained.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From a norma FHIR
Immunization.contained:organizationContained.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From a norma FHIR
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From a norma FHIR
Immunization.vaccineCodepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico
Immunization.reportOriginpreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem
Immunization.sitepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao
Immunization.routepreferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From a norma FHIR
Immunization.protocolApplied.doseNumber[x]preferredhttps://terminologia.saude.gov.br/fhir/ValueSet/BRDose
https://terminologia.saude.gov.br/fhir/ValueSet/BRDose

Restrições

IdGrauCaminho(s)DetalhesRequisitos
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

Resumo

Obrigatório: 5 elementos(11 aninhado obrigatoriamente elementos)
Fixo: 6 elementos
Proibido: 79 elementos

Estruturas

Esta estrutura refere-se a estas outras estruturas:

Fatias

Esta estrutura define os seguintes Slices:

  • The element 1 is sliced based on the value of Immunization.contained
  • The element 1 is sliced based on the value of Immunization.contained.identifier
  • The element 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.performer

 

Other representations of profile: CSV, Excel, Schematron