FR Document Core (FHIR)
0.1.0 - ci-build

FR Document Core (FHIR), publié par Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris. Ce guide n'est pas une publication autorisée ; C'est la version en intégration continue pour la version 0.1.0 construite par le CI Build FHIR (HL7® FHIR® Standard). Cette version est basée sur le contenu actuel de https://github.com/ansforge/interop-IG-fhir-document-core/ et change régulièrement. Voir le répertoire des versions publiées

## Profil de ressource: Immunization - FR Immunization Document

URL officielle: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-immunization-document | Version: 0.1.0 | Surligner les changements ?
Draft à partir de 2026-08-07 | Nom computable: FRImmunizationDocument

FRImmunizationDocument permet de décrire l'administration d'un vaccin.

- Il permet également de décrire pourquoi un vaccin n'a pas été réalisé.

Utilisations:

- Référence ce Profil: ImmunizationRecommendation - FR Immunization Recommendation Document

Vous pouvez également vérifier les usages dans le FHIR IG Statistics

### Vues formelles du contenu du profil

Description des profils, des différentiels, des instantanés et de leurs représentations.

- Tableau des éléments clés
- Tableau différentiel (differential)
- Tableau récapitulatif (snapshot)
- Statistiques/Références
- Tous

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension Constraints: ext-1
Slices pour extension |  | 2..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | code | Value of extension Binding: FRValueSetActorTypeDocument (0.1.0) (required) Motif requis: AUT
extension:typeCode |  | 0..1 | Extension | Type de participation Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "typeCode"
extension:actor |  | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "actor"
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
url |  | 1..1 | uri | "https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension"
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Identifiant
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Motif requis: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices pour coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation | Σ | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system | Σ | 1..1 | uri | Identity of the terminology system
patient | Σ | 1..1 | Reference(Patient) | Who was immunized
occurrence[x] | S Σ | 1..1 | dateTime | Date de la vaccination
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer | Σ | 0..* | BackboneElement | Exécutant
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Motif requis: Au moins les éléments suivants
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S Σ | 0..* | Annotation | Commentaire
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
Slices pour doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.extension:author.​extension:type.value[x] | Base | required | ValueSet - FR ValueSet Actor Type Document | 📍0.1.0 | cet IG
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | Std. FHIR
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
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 | bonne pratique | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Immunization.implicitRules, Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:type.value[x], Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:author.extension:actor.value[x], Immunization.extension:basedOnRequestR5, Immunization.extension:basedOnRequestR5.value[x], Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.vaccineCode, Immunization.vaccineCode.coding, Immunization.vaccineCode.coding:cis, Immunization.vaccineCode.coding:translation, Immunization.vaccineCode.coding:translation.system, Immunization.patient, Immunization.occurrence[x], Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reasonReference, Immunization.isSubpotent, Immunization.protocolApplied, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:basedOnRequestR5, Immunization.modifierExtension, Immunization.performer.modifierExtension, Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Cette structure est dérivée de Immunization

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension
value[x] |  | 0..1 | code | Value of extension Motif requis: AUT
extension:actor |  | 1..1 | Extension | Extension
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
extension |  | 0..0 |  | Extension
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
identifier |  | 0..* | Identifier | Identifiant
status | S | 1..1 | code | completed | entered-in-error | not-done Motif requis: completed
vaccineCode | S | 1..1 | CodeableConcept | Vaccin. Code du produit de santé
Slices pour coding |  | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis |  | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation |  | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system |  | 1..1 | uri | Identity of the terminology system
occurrence[x] | S | 1..1 | dateTime | Date de la vaccination
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer |  | 0..* | BackboneElement | Exécutant
function |  | 0..1 | CodeableConcept | What type of performance was done Motif requis: Au moins les éléments suivants
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
actor |  | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S | 0..* | Annotation | Commentaire
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
Slices pour doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
Documentation pour ce format

#### Bindings terminologiques (différentiel)

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Bindings Additionnels | But
AllLanguages | Binding Max
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
Slices pour extension |  | 2..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | code | Value of extension Binding: FRValueSetActorTypeDocument (0.1.0) (required) Motif requis: AUT
extension:typeCode |  | 0..1 | Extension | Type de participation Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "typeCode"
value[x] |  | 0..1 | CodeableConcept | Value of extension
extension:actor |  | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "actor"
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
url |  | 1..1 | uri | "https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension"
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Identifiant
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Motif requis: completed
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | S Σ | 1..1 | CodeableConcept | Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation | Σ | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | Σ | 1..1 | Reference(Patient) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 | dateTime | Date de la vaccination
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer | Σ | 0..* | BackboneElement | Exécutant
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Motif requis: Au moins les éléments suivants
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S Σ | 0..* | Annotation | Commentaire
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Slices pour doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | Std. FHIR
Immunization.extension:author.​extension:type.value[x] | Base | required | ValueSet - FR ValueSet Actor Type Document | 📍0.1.0 | cet IG
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | Std. FHIR
Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | Std. FHIR
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | Std. FHIR
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | Std. FHIR
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | Std. FHIR
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | Std. FHIR
Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | Std. FHIR
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11
Immunization.protocolApplied.​targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
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 | bonne pratique | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:type.value[x], Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:typeCode.value[x], Immunization.extension:author.extension:actor, Immunization.extension:author.extension:actor.value[x], Immunization.extension:basedOnRequestR5, Immunization.extension:basedOnRequestR5.value[x], Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.vaccineCode.extension, Immunization.vaccineCode.coding, Immunization.vaccineCode.coding:cis, Immunization.vaccineCode.coding:translation, Immunization.vaccineCode.coding:translation.extension, Immunization.vaccineCode.coding:translation.system, Immunization.vaccineCode.coding:translation.version, Immunization.vaccineCode.coding:translation.code, Immunization.vaccineCode.coding:translation.display, Immunization.vaccineCode.coding:translation.userSelected, Immunization.vaccineCode.text, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reasonCode, Immunization.reasonReference, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.education, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.education.documentType, Immunization.education.reference, Immunization.education.publicationDate, Immunization.education.presentationDate, Immunization.programEligibility, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt, Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:basedOnRequestR5, Immunization.modifierExtension, Immunization.vaccineCode.extension, Immunization.vaccineCode.coding:translation.extension, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Cette structure est dérivée de Immunization

Résumé

Obligatoire : 4 éléments(2 éléments obligatoire(s) imbriqué(s))
Must-Support : 12 éléments
Interdit : 1 élément

Structures

Cette structure fait référence à ces autres structures:

- FR PractitionerRole Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-practitionerRole-document|0.1.0)
- FR Patient INS Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-ins-document|0.1.0)
- FR Device Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-device-auteur-document|0.1.0)
- FR Patient Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-document|0.1.0)
- MedicationRequest - FR Medication Request Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-medication-request-document|0.1.0)
- Condition - FR Condition Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-condition-document|0.1.0)

Extensions

Cette structure fait référence à ces extensions:

- https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension|0.1.0
- http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn|0.1.0

Slices

Cette structure définit les slices suivantes:

- The element 1 is sliced based on the value of Immunization.vaccineCode.coding
- The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Vue des éléments clés

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension Constraints: ext-1
Slices pour extension |  | 2..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | code | Value of extension Binding: FRValueSetActorTypeDocument (0.1.0) (required) Motif requis: AUT
extension:typeCode |  | 0..1 | Extension | Type de participation Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "typeCode"
extension:actor |  | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "actor"
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
url |  | 1..1 | uri | "https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension"
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Identifiant
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Motif requis: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices pour coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation | Σ | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system | Σ | 1..1 | uri | Identity of the terminology system
patient | Σ | 1..1 | Reference(Patient) | Who was immunized
occurrence[x] | S Σ | 1..1 | dateTime | Date de la vaccination
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer | Σ | 0..* | BackboneElement | Exécutant
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Motif requis: Au moins les éléments suivants
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S Σ | 0..* | Annotation | Commentaire
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
Slices pour doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.extension:author.​extension:type.value[x] | Base | required | ValueSet - FR ValueSet Actor Type Document | 📍0.1.0 | cet IG
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | Std. FHIR
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
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 | bonne pratique | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Immunization.implicitRules, Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:type.value[x], Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:author.extension:actor.value[x], Immunization.extension:basedOnRequestR5, Immunization.extension:basedOnRequestR5.value[x], Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.vaccineCode, Immunization.vaccineCode.coding, Immunization.vaccineCode.coding:cis, Immunization.vaccineCode.coding:translation, Immunization.vaccineCode.coding:translation.system, Immunization.patient, Immunization.occurrence[x], Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reasonReference, Immunization.isSubpotent, Immunization.protocolApplied, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:basedOnRequestR5, Immunization.modifierExtension, Immunization.performer.modifierExtension, Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Vue différentielle

Cette structure est dérivée de Immunization

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension
value[x] |  | 0..1 | code | Value of extension Motif requis: AUT
extension:actor |  | 1..1 | Extension | Extension
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
extension |  | 0..0 |  | Extension
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
identifier |  | 0..* | Identifier | Identifiant
status | S | 1..1 | code | completed | entered-in-error | not-done Motif requis: completed
vaccineCode | S | 1..1 | CodeableConcept | Vaccin. Code du produit de santé
Slices pour coding |  | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis |  | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation |  | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system |  | 1..1 | uri | Identity of the terminology system
occurrence[x] | S | 1..1 | dateTime | Date de la vaccination
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer |  | 0..* | BackboneElement | Exécutant
function |  | 0..1 | CodeableConcept | What type of performance was done Motif requis: Au moins les éléments suivants
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
actor |  | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S | 0..* | Annotation | Commentaire
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
Slices pour doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
Documentation pour ce format

#### Bindings terminologiques (différentiel)

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11

Vue d'ensembleView

Nom | Drapeaux | Card. | Type | Description et contraintes Filter: Bindings Contraintes Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization(4.0.1) | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Bindings Additionnels | But
AllLanguages | Binding Max
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices pour extension |  | 1..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
extension:author |  | 1..1 | (Complexe) | Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée) URL: https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
Slices pour extension |  | 2..* | Extension | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour extension |  |  |  | Contenu/Règles pour toutes les slices
extension:type |  | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | code | Value of extension Binding: FRValueSetActorTypeDocument (0.1.0) (required) Motif requis: AUT
extension:typeCode |  | 0..1 | Extension | Type de participation Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "typeCode"
value[x] |  | 0..1 | CodeableConcept | Value of extension
extension:actor |  | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "actor"
value[x] |  | 0..1 | Reference(FR PractitionerRole Document(0.1.0) | FR Patient INS Document(0.1.0) | FR Device Document(0.1.0) | FR Patient Document(0.1.0)) | Value of extension
url |  | 1..1 | uri | "https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension"
extension:basedOnRequestR5 |  | 0..1 | (Complexe) | Prescription URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(MedicationRequest - FR Medication Request Document(0.1.0)) | Authority that the immunization event is based on
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Identifiant
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Motif requis: completed
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | S Σ | 1..1 | CodeableConcept | Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
Slices pour coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Non ordonné, Ouvert par value:system
coding:cis | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation | Σ | 0..* | Coding | Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Non ordonné, Ouvert par value:url Constraints: ext-1
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | Σ | 1..1 | Reference(Patient) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 | dateTime | Date de la vaccination
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Numéro de lot.
expirationDate | S | 0..1 | date | Date d'expiration du produit
site | S | 0..1 | CodeableConcept | Région anatomique d'administration Binding: JdvImmunizationApproachSiteCodeCisis (20260619134041) (required)
route | S | 0..1 | CodeableConcept | Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260619134042) (required)
doseQuantity | S | 0..1 | SimpleQuantity(4.0.1) | Dose administrée
performer | Σ | 0..* | BackboneElement | Exécutant
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Motif requis: Au moins les éléments suivants
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Valeur fixe : (Complexe)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Valeur fixe : http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Valeur fixe : AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(FR PractitionerRole Document(0.1.0)) | Individual or organization who was performing
note | S Σ | 0..* | Annotation | Commentaire
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference | S | 0..* | Reference(Condition - FR Condition Document(0.1.0)) | Réaction observée suite au vaccin
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
series |  | 0..1 | string | BOOSTER / IMMUNIZ / INITIMMUNIZ Binding: ActSubstanceAdministrationImmunizationCode (20260619134043) (required)
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Slices pour doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Non ordonné, Ouvert par type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt | S | 0..1 | positiveInt | Rang de la vaccination
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation pour ce format

#### Bindings terminologiques

Chemin | Statut | Usage | Jeu de valeurs (ValueSet) | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | Std. FHIR
Immunization.extension:author.​extension:type.value[x] | Base | required | ValueSet - FR ValueSet Actor Type Document | 📍0.1.0 | cet IG
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | Std. FHIR
Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | Std. FHIR
Immunization.vaccineCode.​coding:cis | Base | required | ValueSet – FR ValueSet Codes vaccins CIS (BDPM) | 📍0.1.0 | cet IG
Immunization.vaccineCode.​coding:translation | Base | required | ValueSet - FR ValueSet Medication Translation Document | 📍0.1.0 | cet IG
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | Std. FHIR
Immunization.site | Base | required | JDV Immunization Approach Site Code CISIS | 📍20260619134041 | Terminologies de Santé v1.11
Immunization.route | Base | required | JDV Immunization Route Code CISIS | 📍20260619134042 | Terminologies de Santé v1.11
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | Std. FHIR
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | Std. FHIR
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | Std. FHIR
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | Std. FHIR
Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | Std. FHIR
Immunization.protocolApplied.​series | Base | required | ActSubstanceAdministrationImmunizationCode | 📍20260619134043 | Terminologies de Santé v1.11
Immunization.protocolApplied.​targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | Std. FHIR

#### Contraintes

Id | Grade | Chemin(s) | Description | Expression
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 | bonne pratique | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:type.value[x], Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:typeCode.value[x], Immunization.extension:author.extension:actor, Immunization.extension:author.extension:actor.value[x], Immunization.extension:basedOnRequestR5, Immunization.extension:basedOnRequestR5.value[x], Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.vaccineCode.extension, Immunization.vaccineCode.coding, Immunization.vaccineCode.coding:cis, Immunization.vaccineCode.coding:translation, Immunization.vaccineCode.coding:translation.extension, Immunization.vaccineCode.coding:translation.system, Immunization.vaccineCode.coding:translation.version, Immunization.vaccineCode.coding:translation.code, Immunization.vaccineCode.coding:translation.display, Immunization.vaccineCode.coding:translation.userSelected, Immunization.vaccineCode.text, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reasonCode, Immunization.reasonReference, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.education, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.education.documentType, Immunization.education.reference, Immunization.education.publicationDate, Immunization.education.presentationDate, Immunization.programEligibility, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt, Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Immunization.extension, Immunization.extension:author, Immunization.extension:author.extension, Immunization.extension:author.extension:type, Immunization.extension:author.extension:typeCode, Immunization.extension:author.extension:actor, Immunization.extension:basedOnRequestR5, Immunization.modifierExtension, Immunization.vaccineCode.extension, Immunization.vaccineCode.coding:translation.extension, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Cette structure est dérivée de Immunization

Résumé

Obligatoire : 4 éléments(2 éléments obligatoire(s) imbriqué(s))
Must-Support : 12 éléments
Interdit : 1 élément

Structures

Cette structure fait référence à ces autres structures:

- FR PractitionerRole Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-practitionerRole-document|0.1.0)
- FR Patient INS Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-ins-document|0.1.0)
- FR Device Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-device-auteur-document|0.1.0)
- FR Patient Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-patient-document|0.1.0)
- MedicationRequest - FR Medication Request Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-medication-request-document|0.1.0)
- Condition - FR Condition Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-condition-document|0.1.0)

Extensions

Cette structure fait référence à ces extensions:

- https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-actor-extension|0.1.0
- http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn|0.1.0

Slices

Cette structure définit les slices suivantes:

- The element 1 is sliced based on the value of Immunization.vaccineCode.coding
- The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Autres représentations du profil : CSV, Excel, Schematron