Search FHIR

FR Document Core (CDA)
0.1.0 - ci-build France (la) flag

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 Vaccin recommande

Official URL: https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-vaccin-recommande Version: 0.1.0
Draft as of 2026-08-28 Computable Name: FRCDAVaccinRecommande

Entrée FR-Vaccin-recommande: IHE-PCC - Immunization recommendation. L'entrée 'Vaccin recommandé' est une entrée de type 'substanceAdministration' qui permet de décrire une vaccination prévue ou proposée. Une vaccination proposée est une proposition qui est utilisée dans la prise de décisions (elle peut apparaître comme une contribution ou un résultat provenant de l'aide à la décision clinique).  Une vaccination prévue dépend d'un plan accepté et à venir. Cette entrée hérite de la structuration, des contraintes et des vocabulaires de l'entrée 'Immunization' (1.3.6.1.4.1.19376.1.5.3.1.4.12).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubstanceAdministration SubstanceAdministration(2.0.3-sd) XML Namespace: urn:hl7-org:v3
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:iheImmunizationRecommandation 1..1 II Conformité Immunization Recommandation (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.2
.... templateId:ccdPlanOfCareActivityPlannedRealised 1..1 II Conformité Plan of care 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.25
.... templateId:frVaccinRecommande 1..1 II Conformité FR-Vaccin-recommande (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.47
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) Si la vaccination est prévue : @moodCode='INT' ; Si la vaccination est proposée :@moodCode='PRP'
... code S 1..1 CD Type d'acte : vaccination
Binding: ActSubstanceAdministrationImmunizationCode (20260716085853) (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 code='active'
.... @code 0..1 cs(2.0.3-sd) Required Pattern: active
... effectiveTime S 1..1 SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS Période de vaccination souhaitable
... 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
... 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
..... @typeCode 1..1 cs(2.0.3-sd) Required Pattern: SUBJ
..... observation 0..1 FRCDARangDeLaVaccination(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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SubstanceAdministration.​code Base required ActSubstanceAdministrationImmunizationCode 📍20260716085853 Terminologies de Santé v1.12
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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:iheImmunizationRecommandation 1..1 II Conformité Immunization Recommandation (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.2
..... @extension 0..1 st(2.0.3-sd)
.... templateId:ccdPlanOfCareActivityPlannedRealised 1..1 II Conformité Plan of care 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.25
..... @extension 0..1 st(2.0.3-sd)
.... templateId:frVaccinRecommande 1..1 II Conformité FR-Vaccin-recommande (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.47
..... @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) Si la vaccination est prévue : @moodCode='INT' ; Si la vaccination est proposée :@moodCode='PRP'
Binding: XDocumentSubstanceMood (2.0.0) (required)
... id S 1..1 II Identifiant de l'entrée
... code S 1..1 CD Type d'acte : vaccination
Binding: ActSubstanceAdministrationImmunizationCode (20260716085853) (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 code='active'
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: active
.... @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 Période de vaccination souhaitable
.... 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 0..* Performer2
... author 0..* Author
... 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
..... @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: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
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco 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:iheImmunizationRecommandation.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:ccdPlanOfCareActivityPlannedRealised.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:frVaccinRecommande.​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 ActSubstanceAdministrationImmunizationCode 📍20260716085853 Terminologies de Santé v1.12
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: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

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:frCommentaireER.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubstanceAdministration SubstanceAdministration(2.0.3-sd) XML Namespace: urn:hl7-org:v3
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:iheImmunizationRecommandation 1..1 II Conformité Immunization Recommandation (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.2
.... templateId:ccdPlanOfCareActivityPlannedRealised 1..1 II Conformité Plan of care 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.25
.... templateId:frVaccinRecommande 1..1 II Conformité FR-Vaccin-recommande (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.47
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) Si la vaccination est prévue : @moodCode='INT' ; Si la vaccination est proposée :@moodCode='PRP'
... code S 1..1 CD Type d'acte : vaccination
Binding: ActSubstanceAdministrationImmunizationCode (20260716085853) (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 code='active'
.... @code 0..1 cs(2.0.3-sd) Required Pattern: active
... effectiveTime S 1..1 SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS Période de vaccination souhaitable
... 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
... 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
..... @typeCode 1..1 cs(2.0.3-sd) Required Pattern: SUBJ
..... observation 0..1 FRCDARangDeLaVaccination(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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SubstanceAdministration.​code Base required ActSubstanceAdministrationImmunizationCode 📍20260716085853 Terminologies de Santé v1.12
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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:iheImmunizationRecommandation 1..1 II Conformité Immunization Recommandation (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.2
..... @extension 0..1 st(2.0.3-sd)
.... templateId:ccdPlanOfCareActivityPlannedRealised 1..1 II Conformité Plan of care 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.25
..... @extension 0..1 st(2.0.3-sd)
.... templateId:frVaccinRecommande 1..1 II Conformité FR-Vaccin-recommande (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.47
..... @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) Si la vaccination est prévue : @moodCode='INT' ; Si la vaccination est proposée :@moodCode='PRP'
Binding: XDocumentSubstanceMood (2.0.0) (required)
... id S 1..1 II Identifiant de l'entrée
... code S 1..1 CD Type d'acte : vaccination
Binding: ActSubstanceAdministrationImmunizationCode (20260716085853) (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 code='active'
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: active
.... @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 Période de vaccination souhaitable
.... 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 0..* Performer2
... author 0..* Author
... 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
..... @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: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
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco 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:iheImmunizationRecommandation.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:ccdPlanOfCareActivityPlannedRealised.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:frVaccinRecommande.​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 ActSubstanceAdministrationImmunizationCode 📍20260716085853 Terminologies de Santé v1.12
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: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

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:frCommentaireER.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

 

Other representations of profile: CSV, Excel