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 Dose antigene

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

Entrée FR-Dose-antigene: IHE-PCC – Antigene-Dose. L'entrée Dose d'antigène permet de décrire des informations complémentaires sur la vaccination, et plus précisément, la dose spécifique d'un antigène.

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 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 2..2 II Slice: Unordered, Open by value:root
.... templateId:iheAntigenDose 1..1 II Conformité Antigen Dose (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.1
.... templateId:frDoseAntigene 1..1 II Conformité FR-Dose-antigene (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.46
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) Required Pattern: EVN
... @negationInd 0..1 bl(2.0.3-sd) Required Pattern: false
... doseQuantity 1..1 IVL_PQ Dose d'antigène
.... @unit 1..1 cs(2.0.3-sd)
.... @value 1..1 real(2.0.3-sd)
... consumable 1..1 FRCDAProduitDeSante(0.1.0) Antigène

doco Documentation for this format
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 2..2 II Slice: Unordered, Open by value:root
.... templateId:iheAntigenDose 1..1 II Conformité Antigen Dose (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.1
..... @extension 0..1 st(2.0.3-sd)
.... templateId:frDoseAntigene 1..1 II Conformité FR-Dose-antigene (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.46
..... @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 la fourniture du DM - Attribué par le LPS avec si possible les attributs @root et @extension. Sinon, un identifiant unique de type UUID est affec-té à l’attribut root et l’attribut extension est omis.
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (2.0.3-sd) (example)
... @negationInd 0..1 bl(2.0.3-sd) Required Pattern: false
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..*
.... 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 0..1 CE Binding: RouteOfAdministration (3.0.0) (example)
... approachSiteCode 0..* CD Binding: ActSite (1.0.0) (example)
... doseQuantity 1..1 IVL_PQ Dose d'antigène
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @unit 1..1 cs(2.0.3-sd)
.... @value 1..1 real(2.0.3-sd)
.... translation 0..* PQR
.... @operator 0..1 cs(2.0.3-sd) Binding: CDASetOperator (2.0.3-sd) (required)
.... low 0..1 IVXB_PQ
.... center 0..1 PQ
.... width 0..1 PQ
.... high 0..1 IVXB_PQ
... 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) Antigène
.... @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
... entryRelationship 0..* EntryRelationship
... 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:iheAntigenDose.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:frDoseAntigene.​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 example CDAActSubstanceAdministrationCode 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​statusCode Base required ActStatus 📍3.0.0 THO v7.3
SubstanceAdministration.​priorityCode Base example ActPriority 📍3.0.0 THO v7.3
SubstanceAdministration.​routeCode Base example RouteOfAdministration 📍3.0.0 THO v7.3
SubstanceAdministration.​approachSiteCode Base example v3 Value Set ActSite 📍1.0.0 THO v7.3
SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📍2.0.3-sd Clinical Document Architecture v2.0
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

Constraints

Id Grade Path(s) Description Expression
II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Summary

Mandatory: 8 elements
Must-Support: 3 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

Differential View

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)
... Slices for templateId 2..2 II Slice: Unordered, Open by value:root
.... templateId:iheAntigenDose 1..1 II Conformité Antigen Dose (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.1
.... templateId:frDoseAntigene 1..1 II Conformité FR-Dose-antigene (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.46
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) Required Pattern: EVN
... @negationInd 0..1 bl(2.0.3-sd) Required Pattern: false
... doseQuantity 1..1 IVL_PQ Dose d'antigène
.... @unit 1..1 cs(2.0.3-sd)
.... @value 1..1 real(2.0.3-sd)
... consumable 1..1 FRCDAProduitDeSante(0.1.0) Antigène

doco Documentation for this format

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 2..2 II Slice: Unordered, Open by value:root
.... templateId:iheAntigenDose 1..1 II Conformité Antigen Dose (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.1
..... @extension 0..1 st(2.0.3-sd)
.... templateId:frDoseAntigene 1..1 II Conformité FR-Dose-antigene (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.46
..... @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 la fourniture du DM - Attribué par le LPS avec si possible les attributs @root et @extension. Sinon, un identifiant unique de type UUID est affec-té à l’attribut root et l’attribut extension est omis.
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (2.0.3-sd) (example)
... @negationInd 0..1 bl(2.0.3-sd) Required Pattern: false
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..*
.... 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 0..1 CE Binding: RouteOfAdministration (3.0.0) (example)
... approachSiteCode 0..* CD Binding: ActSite (1.0.0) (example)
... doseQuantity 1..1 IVL_PQ Dose d'antigène
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @unit 1..1 cs(2.0.3-sd)
.... @value 1..1 real(2.0.3-sd)
.... translation 0..* PQR
.... @operator 0..1 cs(2.0.3-sd) Binding: CDASetOperator (2.0.3-sd) (required)
.... low 0..1 IVXB_PQ
.... center 0..1 PQ
.... width 0..1 PQ
.... high 0..1 IVXB_PQ
... 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) Antigène
.... @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
... entryRelationship 0..* EntryRelationship
... 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:iheAntigenDose.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:frDoseAntigene.​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 example CDAActSubstanceAdministrationCode 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​statusCode Base required ActStatus 📍3.0.0 THO v7.3
SubstanceAdministration.​priorityCode Base example ActPriority 📍3.0.0 THO v7.3
SubstanceAdministration.​routeCode Base example RouteOfAdministration 📍3.0.0 THO v7.3
SubstanceAdministration.​approachSiteCode Base example v3 Value Set ActSite 📍1.0.0 THO v7.3
SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📍2.0.3-sd Clinical Document Architecture v2.0
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

Constraints

Id Grade Path(s) Description Expression
II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Summary

Mandatory: 8 elements
Must-Support: 3 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

 

Other representations of profile: CSV, Excel