Guide d'implémentation du GT Standards et Interopérabilité pour les EDS
0.1.0 - ci-build France flag

Guide d'implémentation du GT Standards et Interopérabilité pour les EDS - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: French branded name Medication

Official URL: https://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/FrMedicationUcd Version: 0.1.0
Draft as of 2024-11-23 Computable Name: FrMedicationUcd

French prescribed, dispensed or used medication expressed as branded medication composed of one to many substances. The code the french UCD (Unité Commune de Dispensation).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication Medication
... code 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... text 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... strength 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
... batch 0..1 BackboneElement Details about packaged medications

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... text Σ 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount C 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 1..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... strength C 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... batch 0..1 BackboneElement Details about packaged medications
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount C 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 1..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength C 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication Medication
... code 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... text 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... strength 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
... batch 0..1 BackboneElement Details about packaged medications

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... text Σ 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount C 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 1..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... strength C 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... batch 0..1 BackboneElement Details about packaged medications
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 1..1 CodeableConcept Codes that identify this medication
Binding: http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: French Medicinal product Dose form (extensible)
... amount C 0..1 FrRatioUcum Amount of drug in the MRequest, MDispense, MAdministration or MUsage
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 1..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Substance or UCD part
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(French Ucd Part Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength C 0..1 FrRatioUcum A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeextensiblehttp://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
http://phast.fr/fhir/ValueSet/Pharmacy/CIOdc/SIPh-CIO_UCD
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formextensibleFrMpDoseForm
https://interop.esante.gouv.fr/ig/fhir/eds/ValueSet/FrMpDoseForm
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

 

Other representations of profile: CSV, Excel, Schematron