Guide d'implémentation du médicament
0.1.0 - ci-build
Guide d'implémentation du médicament
0.1.0 - ci-build
Guide d'implémentation du médicament, published by Interop'Santé. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Interop-Sante/hl7.fhir.fr.medication/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-ucd-part | Version: 0.1.0 | |||
| Draft as of 2024-12-26 | Computable Name: FrMedicationUcdPart | |||
Part of a multipart branded medication.
Description of each multipart proprietary named medication part.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication |
0..* | Medication | Definition of a branded Medication part dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  code |
Σ | 0..1 | CodeableConcept | Short text that identifies this branded medication part Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. ele-1: All FHIR elements must have a @value or children |
  text |
Σ | 1..1 | string | Short plain text representation of the part ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) ele-1: All FHIR elements must have a @value or children | |
| ingredient |
0..* | BackboneElement | Active or inactive ingredient ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 item[x] |
1..1 | The actual substance or sub-part of the part ele-1: All FHIR elements must have a @value or children | ||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||
 itemReference |
Reference(French Ucd Part Medication) | |||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient present ele-1: All FHIR elements must have a @value or children | |
 batch |
0..1 | BackboneElement | Details about packaged medications ele-1: All FHIR elements must have a @value or children | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If 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-4 | error | Medication | If 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a branded Medication part | |
 code |
0..1 | CodeableConcept | Short text that identifies this branded medication part | |
| coding |
0..0 | |||
| text |
1..1 | string | Short plain text representation of the part | |
| manufacturer |
0..0 | |||
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) | |
| ingredient |
0..* | BackboneElement | Active or inactive ingredient | |
| item[x] |
1..1 | The actual substance or sub-part of the part | ||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||
| itemReference |
Reference(French Ucd Part Medication) | |||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient present | |
| batch |
0..1 | BackboneElement | Details about packaged medications | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a branded Medication part | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 |
Σ | 0..1 | CodeableConcept | Short text that identifies this branded medication part Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text |
Σ | 1..1 | string | Short plain text representation of the part | ||||
| 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. | ||||
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient |
0..* | 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 | The actual substance or sub-part of the part | ||||||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||||||
| itemReference |
Reference(French Ucd Part Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If 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-4 | error | Medication | If 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Mandatory: 1 element(1 nested mandatory element)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a branded Medication part dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
Σ | 0..1 | CodeableConcept | Short text that identifies this branded medication part Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Short plain text representation of the part ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) ele-1: All FHIR elements must have a @value or children | |
| ingredient |
0..* | BackboneElement | Active or inactive ingredient ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| item[x] |
1..1 | The actual substance or sub-part of the part ele-1: All FHIR elements must have a @value or children | ||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||
| itemReference |
Reference(French Ucd Part Medication) | |||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient present ele-1: All FHIR elements must have a @value or children | |
| batch |
0..1 | BackboneElement | Details about packaged medications ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If 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-4 | error | Medication | If 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a branded Medication part | |
| code |
0..1 | CodeableConcept | Short text that identifies this branded medication part | |
| coding |
0..0 | |||
| text |
1..1 | string | Short plain text representation of the part | |
| manufacturer |
0..0 | |||
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) | |
| ingredient |
0..* | BackboneElement | Active or inactive ingredient | |
| item[x] |
1..1 | The actual substance or sub-part of the part | ||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||
| itemReference |
Reference(French Ucd Part Medication) | |||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient present | |
| batch |
0..1 | BackboneElement | Details about packaged medications | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a branded Medication part | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 |
Σ | 0..1 | CodeableConcept | Short text that identifies this branded medication part Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text |
Σ | 1..1 | string | Short plain text representation of the part | ||||
| 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. | ||||
| form |
1..1 | CodeableConcept | powder | tablets | capsule + Binding: French Medicinal product Dose form (extensible) | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient |
0..* | 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 | The actual substance or sub-part of the part | ||||||
| itemCodeableConcept |
CodeableConcept(FrMPSubstanceActive) | |||||||
| itemReference |
Reference(French Ucd Part Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | FrRatioUcum | Quantity of ingredient 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | extensible | FrMpDoseFormhttps://hl7.fr/fhir/fr/medication/ValueSet/fr-mp-dose-formfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If 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-4 | error | Medication | If 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Mandatory: 1 element(1 nested mandatory element)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron