FHIR IG analytics| Package | ans.document.fr.core |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-fr-cda-dose-antigene.json |
| FHIR Version | R4 |
| Source | https://interop.esante.gouv.fr/ig/document/core/0.1.0-snapshot/StructureDefinition-fr-cda-dose-antigene.html |
| URL | https://interop.esante.gouv.fr/ig/document/core/StructureDefinition/fr-cda-dose-antigene |
| Version | 0.1.0-snapshot |
| Status | draft |
| Date | 2026-04-15T16:11:27+00:00 |
| Name | FRCDADoseAntigene |
| Title | CDA - FR Dose antigene |
| Realm | fr |
| Description | 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. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| Kind | logical |
| StructureDefinition | ||
| ans.document.fr.core#0.1.0-snapshot | fr-cda-vaccination | CDA - FR Vaccination |
| StructureDefinition | ||
| au.digitalhealth.cda.schema#current | ManufacturedProduct | ManufacturedProduct (CDA Class) |
| au.digitalhealth.cda.schema#current | SubstanceAdministration | SubstanceAdministration (CDA Class) |
| ans.document.fr.core#0.1.0-snapshot | fr-cda-produit-de-sante | CDA - FR Produit de sante |
Note: links and images are rebased to the (stated) source
Narratif généré : DéfinitionStructure fr-cda-dose-antigene
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
  SubstanceAdministration | 1..1 | SubstanceAdministration | Espace de noms (namespace) XML: urn:hl7-org:v3 Base for all types and resources Les instances de ce type sont validées par templateId Conteneur logique: ClinicalDocument (CDA Class) | |
  Slices pour templateId | 2..2 | II | Slice: Non ordonné, Ouvert par value:root | |
   templateId:iheAntigenDose | 1..1 | II | Conformité Antigen Dose (IHE PCC) | |
  @root | 1..1 | oid, uuid, ruid | Motif requis: 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, uuid, ruid | Motif requis: 1.2.250.1.213.1.1.3.46 | |
| @classCode | S | 1..1 | cs | |
| @moodCode | S | 1..1 | cs | Motif requis: EVN |
| id | 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. | |
| @negationInd | 0..1 | bl | Motif requis: false | |
| doseQuantity | 1..1 | IVL_PQ | Dose d'antigène | |
| @unit | 1..1 | cs | ||
 @value | 1..1 | real | ||
 consumable | 1..1 | FRCDAProduitDeSante | Antigène | |
| Documentation pour ce format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "fr-cda-dose-antigene",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "substanceAdministration"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri": "cda"
}
],
"url": "https://interop.esante.gouv.fr/ig/document/core/StructureDefinition/fr-cda-dose-antigene",
"version": "0.1.0-snapshot",
"name": "FRCDADoseAntigene",
"title": "CDA - FR Dose antigene",
"status": "draft",
"date": "2026-04-15T16:11:27+00:00",
"publisher": "Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris",
"contact": [
{
"name": "Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris",
"telecom": [
{
"system": "url",
"value": "https://esante.gouv.fr"
}
]
}
],
"description": "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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "FR",
"display": "FRANCE"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"element": [
{
"id": "SubstanceAdministration",
"path": "SubstanceAdministration",
"short": "Base for all types and resources",
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SubstanceAdministration.nullFlavor",
"path": "SubstanceAdministration.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.realmCode",
"path": "SubstanceAdministration.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "SubstanceAdministration.typeId",
"path": "SubstanceAdministration.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "SubstanceAdministration.typeId.nullFlavor",
"path": "SubstanceAdministration.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.typeId.assigningAuthorityName",
"path": "SubstanceAdministration.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.typeId.displayable",
"path": "SubstanceAdministration.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "SubstanceAdministration.typeId.root",
"path": "SubstanceAdministration.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "SubstanceAdministration.typeId.extension",
"path": "SubstanceAdministration.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId",
"path": "SubstanceAdministration.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 2,
"max": "2",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose",
"path": "SubstanceAdministration.templateId",
"sliceName": "iheAntigenDose",
"short": "Conformité Antigen Dose (IHE PCC) ",
"definition": "Conformité Antigen Dose (IHE PCC)",
"min": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.nullFlavor",
"path": "SubstanceAdministration.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.assigningAuthorityName",
"path": "SubstanceAdministration.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.displayable",
"path": "SubstanceAdministration.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.root",
"path": "SubstanceAdministration.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "1.3.6.1.4.1.19376.1.5.3.1.4.12.1"
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.extension",
"path": "SubstanceAdministration.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene",
"path": "SubstanceAdministration.templateId",
"sliceName": "frDoseAntigene",
"short": "Conformité FR-Dose-antigene (CI-SIS) ",
"definition": "Conformité FR-Dose-antigene (CI-SIS)",
"min": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.nullFlavor",
"path": "SubstanceAdministration.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.assigningAuthorityName",
"path": "SubstanceAdministration.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.displayable",
"path": "SubstanceAdministration.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.root",
"path": "SubstanceAdministration.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "1.2.250.1.213.1.1.3.46"
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.extension",
"path": "SubstanceAdministration.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.classCode",
"path": "SubstanceAdministration.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "SBADM",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id": "SubstanceAdministration.moodCode",
"path": "SubstanceAdministration.moodCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"patternCode": "EVN",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0"
}
},
{
"id": "SubstanceAdministration.id",
"path": "SubstanceAdministration.id",
"short": "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.",
"definition": "Identifiant de la fourniture du DM",
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "SubstanceAdministration.code",
"path": "SubstanceAdministration.code",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode"
}
},
{
"id": "SubstanceAdministration.negationInd",
"path": "SubstanceAdministration.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"patternBoolean": false
},
{
"id": "SubstanceAdministration.text",
"path": "SubstanceAdministration.text",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "SubstanceAdministration.statusCode",
"path": "SubstanceAdministration.statusCode",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.statusCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id": "SubstanceAdministration.effectiveTime",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS"
}
],
"path": "SubstanceAdministration.effectiveTime",
"representation": [
"typeAttr"
],
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.effectiveTime",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS"
},
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id": "SubstanceAdministration.priorityCode",
"path": "SubstanceAdministration.priorityCode",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.priorityCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id": "SubstanceAdministration.repeatNumber",
"path": "SubstanceAdministration.repeatNumber",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.repeatNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT"
}
]
},
{
"id": "SubstanceAdministration.routeCode",
"path": "SubstanceAdministration.routeCode",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.routeCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration"
}
},
{
"id": "SubstanceAdministration.approachSiteCode",
"path": "SubstanceAdministration.approachSiteCode",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.approachSiteCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActSite"
}
},
{
"id": "SubstanceAdministration.doseQuantity",
"path": "SubstanceAdministration.doseQuantity",
"short": "Dose d'antigène",
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.doseQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ"
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.nullFlavor",
"path": "SubstanceAdministration.doseQuantity.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.doseQuantity.unit",
"path": "SubstanceAdministration.doseQuantity.unit",
"representation": [
"xmlAttr"
],
"label": "Unit of Measure",
"definition": "The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].",
"min": 1,
"max": "1",
"base": {
"path": "PQ.unit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "1"
},
{
"id": "SubstanceAdministration.doseQuantity.value",
"path": "SubstanceAdministration.doseQuantity.value",
"representation": [
"xmlAttr"
],
"label": "Maginitude Value",
"definition": "The magnitude of the quantity measured in terms of the unit.",
"min": 1,
"max": "1",
"base": {
"path": "PQ.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/real-simple"
]
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.translation",
"path": "SubstanceAdministration.doseQuantity.translation",
"label": "Translation",
"definition": "An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.",
"min": 0,
"max": "*",
"base": {
"path": "PQ.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQR"
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.operator",
"path": "SubstanceAdministration.doseQuantity.operator",
"representation": [
"xmlAttr"
],
"definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_PQ.operator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "I",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
}
},
{
"id": "SubstanceAdministration.doseQuantity.low",
"path": "SubstanceAdministration.doseQuantity.low",
"label": "Low Boundary",
"definition": "This is the low limit of the interval.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_PQ.low",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ"
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.center",
"path": "SubstanceAdministration.doseQuantity.center",
"label": "Central Value",
"definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_PQ.center",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.width",
"path": "SubstanceAdministration.doseQuantity.width",
"label": "Width",
"definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_PQ.width",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id": "SubstanceAdministration.doseQuantity.high",
"path": "SubstanceAdministration.doseQuantity.high",
"label": "High Boundary",
"definition": "This is the high limit of the interval.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_PQ.high",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ"
}
]
},
{
"id": "SubstanceAdministration.rateQuantity",
"path": "SubstanceAdministration.rateQuantity",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.rateQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ"
}
]
},
{
"id": "SubstanceAdministration.maxDoseQuantity",
"path": "SubstanceAdministration.maxDoseQuantity",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.maxDoseQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ"
}
]
},
{
"id": "SubstanceAdministration.administrationUnitCode",
"path": "SubstanceAdministration.administrationUnitCode",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.administrationUnitCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm"
}
},
{
"id": "SubstanceAdministration.consumable",
"path": "SubstanceAdministration.consumable",
"short": "Antigène",
"definition": "The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.",
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.consumable",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct",
"profile": [
"https://interop.esante.gouv.fr/ig/document/core/StructureDefinition/fr-cda-produit-de-sante"
]
}
]
},
{
"id": "SubstanceAdministration.consumable.nullFlavor",
"path": "SubstanceAdministration.consumable.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.consumable.realmCode",
"path": "SubstanceAdministration.consumable.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "SubstanceAdministration.consumable.typeId",
"path": "SubstanceAdministration.consumable.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "SubstanceAdministration.consumable.typeId.nullFlavor",
"path": "SubstanceAdministration.consumable.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "SubstanceAdministration.consumable.typeId.assigningAuthorityName",
"path": "SubstanceAdministration.consumable.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.consumable.typeId.displayable",
"path": "SubstanceAdministration.consumable.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "SubstanceAdministration.consumable.typeId.root",
"path": "SubstanceAdministration.consumable.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "SubstanceAdministration.consumable.typeId.extension",
"path": "SubstanceAdministration.consumable.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "SubstanceAdministration.consumable.templateId",
"path": "SubstanceAdministration.consumable.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "SubstanceAdministration.consumable.typeCode",
"path": "SubstanceAdministration.consumable.typeCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.consumable.typeCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "CSM",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id": "SubstanceAdministration.consumable.manufacturedProduct",
"path": "SubstanceAdministration.consumable.manufacturedProduct",
"min": 1,
"max": "1",
"base": {
"path": "SubstanceAdministration.consumable.manufacturedProduct",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct"
}
]
},
{
"id": "SubstanceAdministration.subject",
"path": "SubstanceAdministration.subject",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceAdministration.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id": "SubstanceAdministration.specimen",
"path": "SubstanceAdministration.specimen",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
}
]
},
{
"id": "SubstanceAdministration.performer",
"path": "SubstanceAdministration.performer",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
}
]
},
{
"id": "SubstanceAdministration.author",
"path": "SubstanceAdministration.author",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id": "SubstanceAdministration.informant",
"path": "SubstanceAdministration.informant",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id": "SubstanceAdministration.participant",
"path": "SubstanceAdministration.participant",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "SubstanceAdministration.entryRelationship",
"path": "SubstanceAdministration.entryRelationship",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "SubstanceAdministration.reference",
"path": "SubstanceAdministration.reference",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.reference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
}
]
},
{
"id": "SubstanceAdministration.precondition",
"path": "SubstanceAdministration.precondition",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.precondition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
}
]
},
{
"id": "SubstanceAdministration.sdtcInFulfillmentOf1",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "inFulfillmentOf1"
}
],
"path": "SubstanceAdministration.sdtcInFulfillmentOf1",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceAdministration.sdtcInFulfillmentOf1",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1"
}
]
}
]
},
"differential": {
"element": [
{
"id": "SubstanceAdministration",
"path": "SubstanceAdministration"
},
{
"id": "SubstanceAdministration.templateId",
"path": "SubstanceAdministration.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"min": 2,
"max": "2"
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose",
"path": "SubstanceAdministration.templateId",
"sliceName": "iheAntigenDose",
"short": "Conformité Antigen Dose (IHE PCC) ",
"definition": "Conformité Antigen Dose (IHE PCC)",
"min": 1,
"max": "1"
},
{
"id": "SubstanceAdministration.templateId:iheAntigenDose.root",
"path": "SubstanceAdministration.templateId.root",
"min": 1,
"patternString": "1.3.6.1.4.1.19376.1.5.3.1.4.12.1"
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene",
"path": "SubstanceAdministration.templateId",
"sliceName": "frDoseAntigene",
"short": "Conformité FR-Dose-antigene (CI-SIS) ",
"definition": "Conformité FR-Dose-antigene (CI-SIS)",
"min": 1,
"max": "1"
},
{
"id": "SubstanceAdministration.templateId:frDoseAntigene.root",
"path": "SubstanceAdministration.templateId.root",
"min": 1,
"patternString": "1.2.250.1.213.1.1.3.46"
},
{
"id": "SubstanceAdministration.classCode",
"path": "SubstanceAdministration.classCode",
"mustSupport": true
},
{
"id": "SubstanceAdministration.moodCode",
"path": "SubstanceAdministration.moodCode",
"patternCode": "EVN",
"mustSupport": true
},
{
"id": "SubstanceAdministration.id",
"path": "SubstanceAdministration.id",
"short": "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.",
"definition": "Identifiant de la fourniture du DM",
"min": 1,
"max": "1"
},
{
"id": "SubstanceAdministration.negationInd",
"path": "SubstanceAdministration.negationInd",
"patternBoolean": false
},
{
"id": "SubstanceAdministration.doseQuantity",
"path": "SubstanceAdministration.doseQuantity",
"short": "Dose d'antigène",
"min": 1
},
{
"id": "SubstanceAdministration.doseQuantity.unit",
"path": "SubstanceAdministration.doseQuantity.unit",
"min": 1
},
{
"id": "SubstanceAdministration.doseQuantity.value",
"path": "SubstanceAdministration.doseQuantity.value",
"min": 1
},
{
"id": "SubstanceAdministration.consumable",
"path": "SubstanceAdministration.consumable",
"short": "Antigène",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct",
"profile": [
"https://interop.esante.gouv.fr/ig/document/core/StructureDefinition/fr-cda-produit-de-sante"
]
}
]
}
]
}
}