CDA - FR Vaccination - FR Document Core (CDA) v0.1.0

FR Document Core (CDA) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: CDA - FR Vaccination

Official URL: https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-vaccination				Version: 0.1.0	Highlight text changes?
Draft as of 2026-08-28					Computable Name: FRCDAVaccination

Entrée FR-Vaccination: IHE-PCC - Immunizations. L'entrée Vaccination est une entrée de type 'substanceAdministration' pour décrire l'administration d'un vaccin. Elle permet également de décrire pourquoi un vaccin n'a pas été réalisé. Cette entrée hérite de la structuration, des contraintes et des vocabulaires de l'entrée Traitement (1.3.6.1.4.1.19376.1.5.3.1.4.7) sauf mentions précisées ci-après.

Usages:

Use this Logical Model Profile: CDA - FR Vaccinations

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
SubstanceAdministration		1..1	SubstanceAdministration(2.0.3-sd)	XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		3..3	II	Slice: Unordered, Open by value:root
templateId:iheImmunizations		1..1	II	Conformité Immunizations (IHE PCC)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.12
templateId:ccdMedicationActivity		1..1	II	Conformité Medication activity (CCD)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 2.16.840.1.113883.10.20.1.24
templateId:frVaccination		1..1	II	Conformité FR-Vaccination (CI-SIS)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.2.250.1.213.1.1.3.45
@classCode	S	1..1	cs(2.0.3-sd)
@moodCode	S	1..1	cs(2.0.3-sd)	Required Pattern: EVN
id	S	1..1	II	Identifiant de l'entrée
code	S	1..1	CD	Type de vaccination : JDV_HL7_ActSubstanceAdministrationImmunizationCode_CISIS (2.16.840.1.113883.1.11.19709). Il permet d’indiquer si l’entrée concerne une vaccination : - de 1ère série vaccinante ('INITIMMUNIZ') de rappel ('BOOSTER') vaccination sans autre précision ('IMMUNIZ') - de rappel ('BOOSTER') - vaccination sans autre précision ('IMMUNIZ') OR JDV_AbsentOrUnknownImmunization_CISIS (1.2.250.1.213.1.1.5.666) Binding: FRValueSetTypeVaccination (0.1.0) (required)
@code	S	1..1	cs(2.0.3-sd)
@codeSystem	S	1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
@displayName	S	0..1	st(2.0.3-sd)
text	S	1..1	ED	Partie narrative de l’entrée
reference	S	1..1	TEL
statusCode	S	1..1	CS	Statut de l’entréeFixé à la valeur 'completed'
@code		0..1	cs(2.0.3-sd)	Required Pattern: completed
effectiveTime	S	1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS	Date de la vaccination : Si la date de la vaccination est inconnue, utiliser une valeur nullFlavor précisant la raison pour laquelle la date n'est pas connue.
routeCode	S	0..1	CE	Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260716085852) (required)
approachSiteCode	S	0..*	CD	Région anatomique d'administration : Terminologie SNOMED CT (2.16.840.1.113883.6.96) Binding: JdvImmunizationApproachSiteCodeCisis (20260716085851) (required)
doseQuantity	S	0..1	IVL_PQ	Dose administrée
consumable		1..1	FRCDAProduitDeSante(0.1.0)	Vaccin
performer	S	0..1	FRCDAPerformerCorps(0.1.0)	Exécutant
author	S	0..1	FRCDAAuthor(0.1.0)	Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée)
Slices for entryRelationship	S	0..*	EntryRelationship	Slice: Unordered, Open by value:$this
entryRelationship:frPrescription		0..1	EntryRelationship	Prescription
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: REFR
supply		0..1	FRCDAPrescription(0.1.0)
entryRelationship:frRangDeLaVaccination		0..1	EntryRelationship	Rang de la vaccination : Le rang de vaccination permet d'indiquer de quelle injection il s'agit. Par exemple, pour le vaccin contre la coqueluche qui se fait en 2 doses (à 2 mois et à 4 mois pour un nourrisson) + 1 rappel (à 11 mois) on indiquera successivement : - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='1' pour la 1ère dose ; - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='2' pour la 2ème dose ; - Type de vaccination='BOOSTER' pour le ‘Rappel' et rang de la dose='3' pour la 3ème injection
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: SUBJ
observation		0..1	FRCDARangDeLaVaccination(0.1.0)
entryRelationship:frProbleme		0..*	EntryRelationship	Réaction observée suite au vaccin : Un templateId suplémentaire (2.16.840.1.113883.10.20.1.54) ajouté aux déclarations de conformité de l'élément pour indiquer que le problème considéré est une réaction. L'attribut @code de l'élément 'code' prend la valeur 'Symptôme' dont la valeur est prise dans le jeu de valeurs JDV_ProblemCodes_CISIS (1.2.250.1.213.1.1.5.172 ). La réaction observée est codée dans l'élément 'value'.
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: CAUS
@inversionInd		0..1	bl(2.0.3-sd)	Required Pattern: false
observation		0..1	FRCDAProbleme(0.1.0)
entryRelationship:frCommentaireER		0..1	EntryRelationship	Commentaire
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: SUBJ
act		0..1	FRCDACommentaireER(0.1.0)
entryRelationship:frDoseAntigene		0..*	EntryRelationship	Dose d'antigène : Un des cas d'utilisation est la vaccination de sujets hypersensibles [https ://professionnels.vaccination-info-service.fr/Aspects-pratiques/Allergies-et-autres-contre-indications/Personnes-allergiques]
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: COMP
substanceAdministration		0..1	FRCDADoseAntigene(0.1.0)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
SubstanceAdministration.code	Base	required	ValueSet - FR ValueSet Type Vaccination	📍0.1.0	This IG
SubstanceAdministration.routeCode	Base	required	JDV Immunization Route Code CISIS	📍20260716085852	Terminologies de Santé v1.12
SubstanceAdministration.approachSiteCode	Base	required	JDV Immunization Approach Site Code CISIS	📍20260716085851	Terminologies de Santé v1.12

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
SubstanceAdministration		1..1	SubstanceAdministration(2.0.3-sd)	XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
Slices for templateId		3..3	II	Slice: Unordered, Open by value:root
templateId:iheImmunizations		1..1	II	Conformité Immunizations (IHE PCC)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.12
@extension		0..1	st(2.0.3-sd)
templateId:ccdMedicationActivity		1..1	II	Conformité Medication activity (CCD)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 2.16.840.1.113883.10.20.1.24
@extension		0..1	st(2.0.3-sd)
templateId:frVaccination		1..1	II	Conformité FR-Vaccination (CI-SIS)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.2.250.1.213.1.1.3.45
@extension		0..1	st(2.0.3-sd)
@classCode	S	1..1	cs(2.0.3-sd)	Binding: CDAActClass (2.0.3-sd) (required) Fixed Value: SBADM
@moodCode	S	1..1	cs(2.0.3-sd)	Binding: XDocumentSubstanceMood (2.0.0) (required) Required Pattern: EVN
id	S	1..1	II	Identifiant de l'entrée
code	S	1..1	CD	Type de vaccination : JDV_HL7_ActSubstanceAdministrationImmunizationCode_CISIS (2.16.840.1.113883.1.11.19709). Il permet d’indiquer si l’entrée concerne une vaccination : - de 1ère série vaccinante ('INITIMMUNIZ') de rappel ('BOOSTER') vaccination sans autre précision ('IMMUNIZ') - de rappel ('BOOSTER') - vaccination sans autre précision ('IMMUNIZ') OR JDV_AbsentOrUnknownImmunization_CISIS (1.2.250.1.213.1.1.5.666) Binding: FRValueSetTypeVaccination (0.1.0) (required)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@code	S	1..1	cs(2.0.3-sd)
@codeSystem	S	1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
@codeSystemName		0..1	st(2.0.3-sd)
@codeSystemVersion		0..1	st(2.0.3-sd)
@displayName	S	0..1	st(2.0.3-sd)
@sdtcValueSet		0..1	oid(2.0.3-sd)	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st(2.0.3-sd)	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText		0..1	ED
qualifier		0..*	CR
translation		0..*	CD
@negationInd		0..1	bl(2.0.3-sd)
text	S	1..1	ED	Partie narrative de l’entrée
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@compression		0..1	cs(2.0.3-sd)	Binding: CDACompressionAlgorithm (2.0.3-sd) (required)
@integrityCheck		0..1	bin(2.0.3-sd)
@integrityCheckAlgorithm		0..1	cs(2.0.3-sd)	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs(2.0.3-sd)
@mediaType		0..1	cs(2.0.3-sd)	Binding: MediaType (3.0.0) (example)
@representation		0..1	cs(2.0.3-sd)	Binding: BinaryDataEncoding (2.0.3-sd) (required)
xmlText		0..1	st(2.0.3-sd)	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference	S	1..1	TEL
thumbnail	C	0..1	ED	Constraints: ED-1
statusCode	S	1..1	CS	Statut de l’entréeFixé à la valeur 'completed' Binding: ActStatus (3.0.0) (required)
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@code		0..1	cs(2.0.3-sd)	Required Pattern: completed
@sdtcValueSet		0..1	oid(2.0.3-sd)	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st(2.0.3-sd)	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
effectiveTime	S	1..1		Date de la vaccination : Si la date de la vaccination est inconnue, utiliser une valeur nullFlavor précisant la raison pour laquelle la date n'est pas connue.
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..1	CE	Binding: ActPriority (3.0.0) (example)
repeatNumber		0..1	IVL_INT
routeCode	S	0..1	CE	Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260716085852) (required)
approachSiteCode	S	0..*	CD	Région anatomique d'administration : Terminologie SNOMED CT (2.16.840.1.113883.6.96) Binding: JdvImmunizationApproachSiteCodeCisis (20260716085851) (required)
doseQuantity	S	0..1	IVL_PQ	Dose administrée
rateQuantity		0..1	IVL_PQ
maxDoseQuantity		0..1	RTO_PQ_PQ
administrationUnitCode		0..1	CE	Binding: AdministrableDrugForm (3.0.0) (example)
consumable		1..1	FRCDAProduitDeSante(0.1.0)	Vaccin
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		0..1	cs(2.0.3-sd)	Binding: CDAParticipationType (2.0.3-sd) (required) Fixed Value: CSM
manufacturedProduct		1..1	ManufacturedProduct
subject		0..1	Subject
specimen		0..*	Specimen
performer	S	0..1	FRCDAPerformerCorps(0.1.0)	Exécutant
author	S	0..1	FRCDAAuthor(0.1.0)	Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée)
informant		0..*	Informant
participant		0..*	Participant2
Slices for entryRelationship	S	0..*	EntryRelationship	Slice: Unordered, Open by value:$this
entryRelationship:frPrescription		0..1	EntryRelationship	Prescription
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		1..1	cs(2.0.3-sd)	Binding: XActRelationshipEntryRelationship (3.0.0) (required) Required Pattern: REFR
@inversionInd		0..1	bl(2.0.3-sd)
@contextConductionInd		0..1	bl(2.0.3-sd)
@negationInd		0..1	bl(2.0.3-sd)
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	FRCDAPrescription(0.1.0)
entryRelationship:frRangDeLaVaccination		0..1	EntryRelationship	Rang de la vaccination : Le rang de vaccination permet d'indiquer de quelle injection il s'agit. Par exemple, pour le vaccin contre la coqueluche qui se fait en 2 doses (à 2 mois et à 4 mois pour un nourrisson) + 1 rappel (à 11 mois) on indiquera successivement : - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='1' pour la 1ère dose ; - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='2' pour la 2ème dose ; - Type de vaccination='BOOSTER' pour le ‘Rappel' et rang de la dose='3' pour la 3ème injection
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		1..1	cs(2.0.3-sd)	Binding: XActRelationshipEntryRelationship (3.0.0) (required) Required Pattern: SUBJ
@inversionInd		0..1	bl(2.0.3-sd)
@contextConductionInd		0..1	bl(2.0.3-sd)
@negationInd		0..1	bl(2.0.3-sd)
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	FRCDARangDeLaVaccination(0.1.0)
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
entryRelationship:frProbleme		0..*	EntryRelationship	Réaction observée suite au vaccin : Un templateId suplémentaire (2.16.840.1.113883.10.20.1.54) ajouté aux déclarations de conformité de l'élément pour indiquer que le problème considéré est une réaction. L'attribut @code de l'élément 'code' prend la valeur 'Symptôme' dont la valeur est prise dans le jeu de valeurs JDV_ProblemCodes_CISIS (1.2.250.1.213.1.1.5.172 ). La réaction observée est codée dans l'élément 'value'.
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		1..1	cs(2.0.3-sd)	Binding: XActRelationshipEntryRelationship (3.0.0) (required) Required Pattern: CAUS
@inversionInd		0..1	bl(2.0.3-sd)	Required Pattern: false
@contextConductionInd		0..1	bl(2.0.3-sd)
@negationInd		0..1	bl(2.0.3-sd)
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	FRCDAProbleme(0.1.0)
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
entryRelationship:frCommentaireER		0..1	EntryRelationship	Commentaire
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		1..1	cs(2.0.3-sd)	Binding: XActRelationshipEntryRelationship (3.0.0) (required) Required Pattern: SUBJ
@inversionInd		0..1	bl(2.0.3-sd)
@contextConductionInd		0..1	bl(2.0.3-sd)
@negationInd		0..1	bl(2.0.3-sd)
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		0..1	FRCDACommentaireER(0.1.0)
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
entryRelationship:frDoseAntigene		0..*	EntryRelationship	Dose d'antigène : Un des cas d'utilisation est la vaccination de sujets hypersensibles [https ://professionnels.vaccination-info-service.fr/Aspects-pratiques/Allergies-et-autres-contre-indications/Personnes-allergiques]
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs(2.0.3-sd)	Binding: CDANullFlavor (2.0.3-sd) (required)
@assigningAuthorityName		0..1	st(2.0.3-sd)
@displayable		0..1	bl(2.0.3-sd)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st(2.0.3-sd)
templateId		0..*	II
@typeCode		1..1	cs(2.0.3-sd)	Binding: XActRelationshipEntryRelationship (3.0.0) (required) Required Pattern: COMP
@inversionInd		0..1	bl(2.0.3-sd)
@contextConductionInd		0..1	bl(2.0.3-sd)
@negationInd		0..1	bl(2.0.3-sd)
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	FRCDADoseAntigene(0.1.0)
supply		0..1	Supply
reference		0..*	Reference
precondition		0..*	Precondition
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
SubstanceAdministration.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.templateId:iheImmunizations.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.templateId:ccdMedicationActivity.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.templateId:frVaccination.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.classCode	Base	required	CDAActClass	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.moodCode	Base	required	x_DocumentSubstanceMood	📍2.0.0	THO v5.2
SubstanceAdministration.code	Base	required	ValueSet - FR ValueSet Type Vaccination	📍0.1.0	This IG
SubstanceAdministration.code.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.text.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.text.compression	Base	required	CDACompressionAlgorithm	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.text.integrityCheckAlgorithm	Base	required	IntegrityCheckAlgorithm	📍2.0.0	THO v5.2
SubstanceAdministration.text.mediaType	Base	example	MediaType	📍3.0.0	THO v7.3
SubstanceAdministration.text.representation	Base	required	CDABinaryDataEncoding	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.statusCode	Base	required	ActStatus	📍3.0.0	THO v7.3
SubstanceAdministration.statusCode.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.priorityCode	Base	example	ActPriority	📍3.0.0	THO v7.3
SubstanceAdministration.routeCode	Base	required	JDV Immunization Route Code CISIS	📍20260716085852	Terminologies de Santé v1.12
SubstanceAdministration.approachSiteCode	Base	required	JDV Immunization Approach Site Code CISIS	📍20260716085851	Terminologies de Santé v1.12
SubstanceAdministration.administrationUnitCode	Base	example	AdministrableDrugForm	📍3.0.0	THO v7.3
SubstanceAdministration.consumable.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.consumable.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.consumable.typeCode	Base	required	CDAParticipationType	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frPrescription.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frPrescription.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frPrescription.typeCode	Base	required	x_ActRelationshipEntryRelationship	📍3.0.0	THO v7.3
SubstanceAdministration.entryRelationship:frRangDeLaVaccination.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frRangDeLaVaccination.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frRangDeLaVaccination.typeCode	Base	required	x_ActRelationshipEntryRelationship	📍3.0.0	THO v7.3
SubstanceAdministration.entryRelationship:frProbleme.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frProbleme.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frProbleme.typeCode	Base	required	x_ActRelationshipEntryRelationship	📍3.0.0	THO v7.3
SubstanceAdministration.entryRelationship:frCommentaireER.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frCommentaireER.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frCommentaireER.typeCode	Base	required	x_ActRelationshipEntryRelationship	📍3.0.0	THO v7.3
SubstanceAdministration.entryRelationship:frDoseAntigene.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frDoseAntigene.typeId.nullFlavor	Base	required	CDANullFlavor	📍2.0.3-sd	Clinical Document Architecture v2.0
SubstanceAdministration.entryRelationship:frDoseAntigene.typeCode	Base	required	x_ActRelationshipEntryRelationship	📍3.0.0	THO v7.3

Constraints

Id	Grade	Path(s)	Description	Expression
ED-1	error	SubstanceAdministration.text.thumbnail	Thumbnails cannot contain their own thumbnails	`thumbnail.empty()`
II-1	error	SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.entryRelationship:frPrescription.typeId, SubstanceAdministration.entryRelationship:frRangDeLaVaccination.typeId, SubstanceAdministration.entryRelationship:frProbleme.typeId, SubstanceAdministration.entryRelationship:frCommentaireER.typeId, SubstanceAdministration.entryRelationship:frDoseAntigene.typeId	An II instance must have either a root or an nullFlavor.	`root.exists() or nullFlavor.exists()`

Summary

Mandatory: 14 elements
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of SubstanceAdministration.templateId
The element 1 is sliced based on the value of SubstanceAdministration.entryRelationship

Differential View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
SubstanceAdministration		1..1	SubstanceAdministration(2.0.3-sd)	XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		3..3	II	Slice: Unordered, Open by value:root
templateId:iheImmunizations		1..1	II	Conformité Immunizations (IHE PCC)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.12
templateId:ccdMedicationActivity		1..1	II	Conformité Medication activity (CCD)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 2.16.840.1.113883.10.20.1.24
templateId:frVaccination		1..1	II	Conformité FR-Vaccination (CI-SIS)
@root		1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)	Required Pattern: 1.2.250.1.213.1.1.3.45
@classCode	S	1..1	cs(2.0.3-sd)
@moodCode	S	1..1	cs(2.0.3-sd)	Required Pattern: EVN
id	S	1..1	II	Identifiant de l'entrée
code	S	1..1	CD	Type de vaccination : JDV_HL7_ActSubstanceAdministrationImmunizationCode_CISIS (2.16.840.1.113883.1.11.19709). Il permet d’indiquer si l’entrée concerne une vaccination : - de 1ère série vaccinante ('INITIMMUNIZ') de rappel ('BOOSTER') vaccination sans autre précision ('IMMUNIZ') - de rappel ('BOOSTER') - vaccination sans autre précision ('IMMUNIZ') OR JDV_AbsentOrUnknownImmunization_CISIS (1.2.250.1.213.1.1.5.666) Binding: FRValueSetTypeVaccination (0.1.0) (required)
@code	S	1..1	cs(2.0.3-sd)
@codeSystem	S	1..1	oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
@displayName	S	0..1	st(2.0.3-sd)
text	S	1..1	ED	Partie narrative de l’entrée
reference	S	1..1	TEL
statusCode	S	1..1	CS	Statut de l’entréeFixé à la valeur 'completed'
@code		0..1	cs(2.0.3-sd)	Required Pattern: completed
effectiveTime	S	1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS	Date de la vaccination : Si la date de la vaccination est inconnue, utiliser une valeur nullFlavor précisant la raison pour laquelle la date n'est pas connue.
routeCode	S	0..1	CE	Voie d'administration Binding: JdvImmunizationRouteCodeCisis (20260716085852) (required)
approachSiteCode	S	0..*	CD	Région anatomique d'administration : Terminologie SNOMED CT (2.16.840.1.113883.6.96) Binding: JdvImmunizationApproachSiteCodeCisis (20260716085851) (required)
doseQuantity	S	0..1	IVL_PQ	Dose administrée
consumable		1..1	FRCDAProduitDeSante(0.1.0)	Vaccin
performer	S	0..1	FRCDAPerformerCorps(0.1.0)	Exécutant
author	S	0..1	FRCDAAuthor(0.1.0)	Auteur de la vaccination (personne ayant validé médicalement que la vaccination a été réalisée)
Slices for entryRelationship	S	0..*	EntryRelationship	Slice: Unordered, Open by value:$this
entryRelationship:frPrescription		0..1	EntryRelationship	Prescription
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: REFR
supply		0..1	FRCDAPrescription(0.1.0)
entryRelationship:frRangDeLaVaccination		0..1	EntryRelationship	Rang de la vaccination : Le rang de vaccination permet d'indiquer de quelle injection il s'agit. Par exemple, pour le vaccin contre la coqueluche qui se fait en 2 doses (à 2 mois et à 4 mois pour un nourrisson) + 1 rappel (à 11 mois) on indiquera successivement : - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='1' pour la 1ère dose ; - Type de vaccination='INITIMMUNIZ' pour la '1ère série vaccinante' et rang de la dose='2' pour la 2ème dose ; - Type de vaccination='BOOSTER' pour le ‘Rappel' et rang de la dose='3' pour la 3ème injection
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: SUBJ
observation		0..1	FRCDARangDeLaVaccination(0.1.0)
entryRelationship:frProbleme		0..*	EntryRelationship	Réaction observée suite au vaccin : Un templateId suplémentaire (2.16.840.1.113883.10.20.1.54) ajouté aux déclarations de conformité de l'élément pour indiquer que le problème considéré est une réaction. L'attribut @code de l'élément 'code' prend la valeur 'Symptôme' dont la valeur est prise dans le jeu de valeurs JDV_ProblemCodes_CISIS (1.2.250.1.213.1.1.5.172 ). La réaction observée est codée dans l'élément 'value'.
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: CAUS
@inversionInd		0..1	bl(2.0.3-sd)	Required Pattern: false
observation		0..1	FRCDAProbleme(0.1.0)
entryRelationship:frCommentaireER		0..1	EntryRelationship	Commentaire
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: SUBJ
act		0..1	FRCDACommentaireER(0.1.0)
entryRelationship:frDoseAntigene		0..*	EntryRelationship	Dose d'antigène : Un des cas d'utilisation est la vaccination de sujets hypersensibles [https ://professionnels.vaccination-info-service.fr/Aspects-pratiques/Allergies-et-autres-contre-indications/Personnes-allergiques]
@typeCode		1..1	cs(2.0.3-sd)	Required Pattern: COMP
substanceAdministration		0..1	FRCDADoseAntigene(0.1.0)
Documentation for this format