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 DICOM Administration produit de sante

Official URL: https://interop.esante.gouv.fr/ig/cda/document-core/StructureDefinition/fr-cda-dicom-administration-produit-de-sante Version: 0.1.0
Draft as of 2026-08-28 Computable Name: FRCDADICOMAdministrationProduitDeSante

Entrée FR-DICOM-Administration-produit-de-sante: DICOM Part 20 - Procedural Medication. Cette entrée permet d'enregistrer l’administration de produits (hors radiopharmaceutiques) :

  • produit administré
  • dose administréevoie d’administration
  • numéro de lot
  • autres informations liées à l’administration d’un produit

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 2..2 II Slice: Unordered, Open by value:root
.... templateId:frDicomAdministrationProduitDeSante 1..1 II Conformité FR-DICOM-Administration-produit-de-sante (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.151
.... templateId:dicomProceduralMedication 1..1 II Conformité Procedural Medication (DICOM Part 20)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 1.2.840.10008.9.13
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) - Si le traitement a déjà été administré ou si information rapportée par le patient ou si aucun traitement : moodCode='EVN' - Si le traitement est en attente d'administration : moodCode='INT'
... text S 0..1 ED Partie narrative de l'entrée
.... reference S 0..1 TEL
... statusCode S 1..1 CS Status de l'entrée
.... @code 0..1 cs(2.0.3-sd) Required Pattern: completed
... routeCode S 0..1 CE Voie d'administration Terminologie utilisée : EDQM - Standard terms / classe ROA (Voie d'administration)
... doseQuantity S 0..1 IVL_PQ Dose à administrer. S'il n'y a pas de traitement, utiliser une valeur nullFlavor. S'il y a un traitement, les sous-éléments 'low' et 'high' permettent de fournir les doses minimales et maximales à administrer. Dans le cas où la dose est fixe, ces deux sous-éléments prendront les mêmes valeurs. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information. Dans le cas où l'on s'exprime en quantités indénombrables, l'unité doit être transmise. Les unités sont exprimées selon le système de codage UCUM. Dans le cas où l'on s'exprime en quantités dénombrables (capsules, comprimés, gélules, etc.) l'unité ne doit pas être renseignée. A la place, on ajoute un champ 'translation' qui permet de pointer sur l'élément de la partie narrative relative à cette information.
... rateQuantity S 0..1 IVL_PQ Rythme d'administration. Le rythme d'administration permet d'indiquer la quantité de produit à administrer par unité de temps. Les sous-éléments 'low' et 'high' permettent de fournir le rythme minimal et maximal de l'administration. Dans le cas où le rythme est fixe, ces deux sous-éléments prendront les mêmes valeurs. L'argument @value permet d'indiquer la quantité de produit à administrer. L'argument @unit permet d'indiquer le rythme d'administration en combinant l'unité de quantité et l'unité de temps (séparés par le caractère ‘/'). Les unités sont exprimées selon le système de codage UCUM. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information.
... consumable S 1..1 InfrastructureRoot Médicament
.... manufacturedProduct S 1..1 ManufacturedProduct Produit de santé
..... manufacturedMaterial 1..1 Material
...... code S 0..1 CE Choix parmi les éléments suivants: code et nullFlavor. Code du produit de santé. - CIP : Code Identifiant de Présentation (1.2.250.1.213.2.3.2) - UCD : Unités Communes de Dispensation (1.2.250.1.213.2.61) + code ATC
....... originalText S 1..1 ED
........ reference S 1..1 TEL
....... translation S 0..* CD - ATC : Classification anatomique, thérapeutique et chimique (2.16.840.1.113883.6.73) - CIS : Code Identifiant de Spécialité (1.2.250.1.213.2.3.1) - MV : Médicament Virtuel (1.2.250.1.213.2.59) de Medicabase
...... name 0..1 EN Nom de marque du produit
...... lotNumberText 0..1 ST Numéro de lot

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:frDicomAdministrationProduitDeSante 1..1 II Conformité FR-DICOM-Administration-produit-de-sante (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.151
..... @extension 0..1 st(2.0.3-sd)
.... templateId:dicomProceduralMedication 1..1 II Conformité Procedural Medication (DICOM Part 20)
..... @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.840.10008.9.13
..... @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 le traitement a déjà été administré ou si information rapportée par le patient ou si aucun traitement : moodCode='EVN' - Si le traitement est en attente d'administration : moodCode='INT'
Binding: XDocumentSubstanceMood (2.0.0) (required)
... id S 1..1 II Identifiant de l'entrée
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (2.0.3-sd) (example)
... @negationInd 0..1 bl(2.0.3-sd)
... text S 0..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 0..1 TEL
.... thumbnail C 0..1 ED Constraints: ED-1
... statusCode S 1..1 CS Status de l'entrée
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 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 S 0..1 CE Voie d'administration Terminologie utilisée : EDQM - Standard terms / classe ROA (Voie d'administration)
Binding: RouteOfAdministration (3.0.0) (example)
... approachSiteCode 0..* CD Binding: ActSite (1.0.0) (example)
... doseQuantity S 0..1 IVL_PQ Dose à administrer. S'il n'y a pas de traitement, utiliser une valeur nullFlavor. S'il y a un traitement, les sous-éléments 'low' et 'high' permettent de fournir les doses minimales et maximales à administrer. Dans le cas où la dose est fixe, ces deux sous-éléments prendront les mêmes valeurs. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information. Dans le cas où l'on s'exprime en quantités indénombrables, l'unité doit être transmise. Les unités sont exprimées selon le système de codage UCUM. Dans le cas où l'on s'exprime en quantités dénombrables (capsules, comprimés, gélules, etc.) l'unité ne doit pas être renseignée. A la place, on ajoute un champ 'translation' qui permet de pointer sur l'élément de la partie narrative relative à cette information.
... rateQuantity S 0..1 IVL_PQ Rythme d'administration. Le rythme d'administration permet d'indiquer la quantité de produit à administrer par unité de temps. Les sous-éléments 'low' et 'high' permettent de fournir le rythme minimal et maximal de l'administration. Dans le cas où le rythme est fixe, ces deux sous-éléments prendront les mêmes valeurs. L'argument @value permet d'indiquer la quantité de produit à administrer. L'argument @unit permet d'indiquer le rythme d'administration en combinant l'unité de quantité et l'unité de temps (séparés par le caractère ‘/'). Les unités sont exprimées selon le système de codage UCUM. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information.
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: AdministrableDrugForm (3.0.0) (example)
... consumable S 1..1 InfrastructureRoot Médicament
.... @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 S 1..1 ManufacturedProduct Produit de santé
..... @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
..... @classCode 0..1 cs(2.0.3-sd) Binding: RoleClassManufacturedProduct (3.0.0) (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... manufacturedLabeledDrug 0..1 LabeledDrug
..... manufacturedMaterial 1..1 Material
...... @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
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassManufacturedMaterial (3.0.0) (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminerDetermined (3.0.0) (required)
Fixed Value: KIND
...... code S 0..1 CE Choix parmi les éléments suivants: code et nullFlavor. Code du produit de santé. - CIP : Code Identifiant de Présentation (1.2.250.1.213.2.3.2) - UCD : Unités Communes de Dispensation (1.2.250.1.213.2.61) + code ATC
Binding: CDAMaterialEntityClassType (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd)
....... @codeSystem 0..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 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 S 1..1 ED
........ @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
....... translation S 0..* CD - ATC : Classification anatomique, thérapeutique et chimique (2.16.840.1.113883.6.73) - CIS : Code Identifiant de Spécialité (1.2.250.1.213.2.3.1) - MV : Médicament Virtuel (1.2.250.1.213.2.59) de Medicabase
...... name 0..1 EN Nom de marque du produit
...... lotNumberText 0..1 ST Numéro de lot
...... sdtcExpirationTime 0..1 IVL_TS XML Namespace: urn:hl7-org:sdtc
XML: expirationTime (urn:hl7-org:sdtc)
..... manufacturerOrganization 0..1 Organization
... 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:frDicomAdministrationProduitDeSante.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:dicomProceduralMedication.​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.​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 example RouteOfAdministration 📍3.0.0 THO v7.3
SubstanceAdministration.​approachSiteCode Base example v3 Value Set ActSite 📍1.0.0 THO v7.3
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.​consumable.manufacturedProduct.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​classCode Base required RoleClassManufacturedProduct 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​classCode Base required EntityClassManufacturedMaterial 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​determinerCode Base required EntityDeterminerDetermined 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code Base example CDAMaterialEntityClassType 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.compression Base required CDACompressionAlgorithm 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.mediaType Base example MediaType 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.representation Base required CDABinaryDataEncoding 📍2.0.3-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
ED-1 error SubstanceAdministration.text.thumbnail, SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.originalText.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.consumable.manufacturedProduct.typeId, SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 15 elements

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 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 2..2 II Slice: Unordered, Open by value:root
.... templateId:frDicomAdministrationProduitDeSante 1..1 II Conformité FR-DICOM-Administration-produit-de-sante (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.151
.... templateId:dicomProceduralMedication 1..1 II Conformité Procedural Medication (DICOM Part 20)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 1.2.840.10008.9.13
... @classCode S 1..1 cs(2.0.3-sd)
... @moodCode S 1..1 cs(2.0.3-sd) - Si le traitement a déjà été administré ou si information rapportée par le patient ou si aucun traitement : moodCode='EVN' - Si le traitement est en attente d'administration : moodCode='INT'
... text S 0..1 ED Partie narrative de l'entrée
.... reference S 0..1 TEL
... statusCode S 1..1 CS Status de l'entrée
.... @code 0..1 cs(2.0.3-sd) Required Pattern: completed
... routeCode S 0..1 CE Voie d'administration Terminologie utilisée : EDQM - Standard terms / classe ROA (Voie d'administration)
... doseQuantity S 0..1 IVL_PQ Dose à administrer. S'il n'y a pas de traitement, utiliser une valeur nullFlavor. S'il y a un traitement, les sous-éléments 'low' et 'high' permettent de fournir les doses minimales et maximales à administrer. Dans le cas où la dose est fixe, ces deux sous-éléments prendront les mêmes valeurs. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information. Dans le cas où l'on s'exprime en quantités indénombrables, l'unité doit être transmise. Les unités sont exprimées selon le système de codage UCUM. Dans le cas où l'on s'exprime en quantités dénombrables (capsules, comprimés, gélules, etc.) l'unité ne doit pas être renseignée. A la place, on ajoute un champ 'translation' qui permet de pointer sur l'élément de la partie narrative relative à cette information.
... rateQuantity S 0..1 IVL_PQ Rythme d'administration. Le rythme d'administration permet d'indiquer la quantité de produit à administrer par unité de temps. Les sous-éléments 'low' et 'high' permettent de fournir le rythme minimal et maximal de l'administration. Dans le cas où le rythme est fixe, ces deux sous-éléments prendront les mêmes valeurs. L'argument @value permet d'indiquer la quantité de produit à administrer. L'argument @unit permet d'indiquer le rythme d'administration en combinant l'unité de quantité et l'unité de temps (séparés par le caractère ‘/'). Les unités sont exprimées selon le système de codage UCUM. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information.
... consumable S 1..1 InfrastructureRoot Médicament
.... manufacturedProduct S 1..1 ManufacturedProduct Produit de santé
..... manufacturedMaterial 1..1 Material
...... code S 0..1 CE Choix parmi les éléments suivants: code et nullFlavor. Code du produit de santé. - CIP : Code Identifiant de Présentation (1.2.250.1.213.2.3.2) - UCD : Unités Communes de Dispensation (1.2.250.1.213.2.61) + code ATC
....... originalText S 1..1 ED
........ reference S 1..1 TEL
....... translation S 0..* CD - ATC : Classification anatomique, thérapeutique et chimique (2.16.840.1.113883.6.73) - CIS : Code Identifiant de Spécialité (1.2.250.1.213.2.3.1) - MV : Médicament Virtuel (1.2.250.1.213.2.59) de Medicabase
...... name 0..1 EN Nom de marque du produit
...... lotNumberText 0..1 ST Numéro de lot

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:frDicomAdministrationProduitDeSante 1..1 II Conformité FR-DICOM-Administration-produit-de-sante (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.151
..... @extension 0..1 st(2.0.3-sd)
.... templateId:dicomProceduralMedication 1..1 II Conformité Procedural Medication (DICOM Part 20)
..... @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.840.10008.9.13
..... @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 le traitement a déjà été administré ou si information rapportée par le patient ou si aucun traitement : moodCode='EVN' - Si le traitement est en attente d'administration : moodCode='INT'
Binding: XDocumentSubstanceMood (2.0.0) (required)
... id S 1..1 II Identifiant de l'entrée
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (2.0.3-sd) (example)
... @negationInd 0..1 bl(2.0.3-sd)
... text S 0..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 0..1 TEL
.... thumbnail C 0..1 ED Constraints: ED-1
... statusCode S 1..1 CS Status de l'entrée
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 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 S 0..1 CE Voie d'administration Terminologie utilisée : EDQM - Standard terms / classe ROA (Voie d'administration)
Binding: RouteOfAdministration (3.0.0) (example)
... approachSiteCode 0..* CD Binding: ActSite (1.0.0) (example)
... doseQuantity S 0..1 IVL_PQ Dose à administrer. S'il n'y a pas de traitement, utiliser une valeur nullFlavor. S'il y a un traitement, les sous-éléments 'low' et 'high' permettent de fournir les doses minimales et maximales à administrer. Dans le cas où la dose est fixe, ces deux sous-éléments prendront les mêmes valeurs. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information. Dans le cas où l'on s'exprime en quantités indénombrables, l'unité doit être transmise. Les unités sont exprimées selon le système de codage UCUM. Dans le cas où l'on s'exprime en quantités dénombrables (capsules, comprimés, gélules, etc.) l'unité ne doit pas être renseignée. A la place, on ajoute un champ 'translation' qui permet de pointer sur l'élément de la partie narrative relative à cette information.
... rateQuantity S 0..1 IVL_PQ Rythme d'administration. Le rythme d'administration permet d'indiquer la quantité de produit à administrer par unité de temps. Les sous-éléments 'low' et 'high' permettent de fournir le rythme minimal et maximal de l'administration. Dans le cas où le rythme est fixe, ces deux sous-éléments prendront les mêmes valeurs. L'argument @value permet d'indiquer la quantité de produit à administrer. L'argument @unit permet d'indiquer le rythme d'administration en combinant l'unité de quantité et l'unité de temps (séparés par le caractère ‘/'). Les unités sont exprimées selon le système de codage UCUM. Dans chaque élément 'low' et 'high', un élément 'translation' peut permettre de pointer sur l'élément de la partie narrative relative à cette information.
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: AdministrableDrugForm (3.0.0) (example)
... consumable S 1..1 InfrastructureRoot Médicament
.... @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 S 1..1 ManufacturedProduct Produit de santé
..... @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
..... @classCode 0..1 cs(2.0.3-sd) Binding: RoleClassManufacturedProduct (3.0.0) (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... manufacturedLabeledDrug 0..1 LabeledDrug
..... manufacturedMaterial 1..1 Material
...... @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
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassManufacturedMaterial (3.0.0) (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminerDetermined (3.0.0) (required)
Fixed Value: KIND
...... code S 0..1 CE Choix parmi les éléments suivants: code et nullFlavor. Code du produit de santé. - CIP : Code Identifiant de Présentation (1.2.250.1.213.2.3.2) - UCD : Unités Communes de Dispensation (1.2.250.1.213.2.61) + code ATC
Binding: CDAMaterialEntityClassType (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd)
....... @codeSystem 0..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 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 S 1..1 ED
........ @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
....... translation S 0..* CD - ATC : Classification anatomique, thérapeutique et chimique (2.16.840.1.113883.6.73) - CIS : Code Identifiant de Spécialité (1.2.250.1.213.2.3.1) - MV : Médicament Virtuel (1.2.250.1.213.2.59) de Medicabase
...... name 0..1 EN Nom de marque du produit
...... lotNumberText 0..1 ST Numéro de lot
...... sdtcExpirationTime 0..1 IVL_TS XML Namespace: urn:hl7-org:sdtc
XML: expirationTime (urn:hl7-org:sdtc)
..... manufacturerOrganization 0..1 Organization
... 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:frDicomAdministrationProduitDeSante.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​templateId:dicomProceduralMedication.​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.​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 example RouteOfAdministration 📍3.0.0 THO v7.3
SubstanceAdministration.​approachSiteCode Base example v3 Value Set ActSite 📍1.0.0 THO v7.3
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.​consumable.manufacturedProduct.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​classCode Base required RoleClassManufacturedProduct 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​classCode Base required EntityClassManufacturedMaterial 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​determinerCode Base required EntityDeterminerDetermined 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code Base example CDAMaterialEntityClassType 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.compression Base required CDACompressionAlgorithm 📍2.0.3-sd Clinical Document Architecture v2.0
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.mediaType Base example MediaType 📍3.0.0 THO v7.3
SubstanceAdministration.​consumable.manufacturedProduct.​manufacturedMaterial.​code.originalText.representation Base required CDABinaryDataEncoding 📍2.0.3-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
ED-1 error SubstanceAdministration.text.thumbnail, SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.originalText.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.consumable.manufacturedProduct.typeId, SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 15 elements

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