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-history-medicationstatement | Version: 0.1.0 | |||
Draft as of 2024-12-26 | Computable Name: FrMedicationHistoryMedicationStatement |
Profil de la ressource MedicationStatement du Bilan médicamenteux. Medication History MedicationStatement resource profile
Ce profil est utilisé pour les ressources MedicationStatement figurant dans un bilan médicamenteux. Chaque ressource MeciationStatement y représente une ligne de médicament du Bilan.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux 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 | |||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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 | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. ele-1: All FHIR elements must have a @value or children | ||||
medication[x] | SΣ | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne ele-1: All FHIR elements must have a @value or children | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Medication | ||||
subject | SΣ | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Patient | ||||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken 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 | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children | ||||
dose[x] | SΣ | 0..1 | Precise amount of medication per dose ele-1: All FHIR elements must have a @value or children | |||||
doseRange | Range(FrRangeUcum) | |||||||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
rate[x] | SΣ | 0..1 | Amount of medication per unit of time ele-1: All FHIR elements must have a @value or children | |||||
rateRatio | Ratio(FrRatioUcum) | |||||||
rateRange | Range(FrRangeUcum) | |||||||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
maxDosePerPeriod | SΣ | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time ele-1: All FHIR elements must have a @value or children | ||||
maxDosePerAdministration | SΣ | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit ele-1: All FHIR elements must have a @value or children | ||||
maxDosePerLifetime | SΣ | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.medication[x].type | extensible | Fixed Value: Medicationhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | Fixed Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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 MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux | |
meta | ||||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..1 | code | Language of the resource content | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
medication[x] | S | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Medication | |
identifier | 0..0 | |||
subject | S | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the medication |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Patient | |
informationSource | S | 0..0 | ||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
doseAndRate | ||||
dose[x] | S | 0..1 | Precise amount of medication per dose | |
doseRange | Range(FrRangeUcum) | |||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||
rate[x] | S | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio(FrRatioUcum) | |||
rateRange | Range(FrRangeUcum) | |||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||
maxDosePerPeriod | S | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time |
maxDosePerAdministration | S | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit |
maxDosePerLifetime | S | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
medication[x] | SΣ | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Medication | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
subject | SΣ | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the 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 | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Patient | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..* | Annotation | Further information about the statement | |||||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
dose[x] | SΣ | 0..1 | Precise amount of medication per dose | |||||
doseRange | Range(FrRangeUcum) | |||||||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
rate[x] | SΣ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio(FrRatioUcum) | |||||||
rateRange | Range(FrRangeUcum) | |||||||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
maxDosePerPeriod | SΣ | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time | ||||
maxDosePerAdministration | SΣ | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit | ||||
maxDosePerLifetime | SΣ | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x].type | extensible | Fixed Value: Medicationhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | Fixed Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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 MedicationStatement
Summary
Mandatory: 1 element
Must-Support: 11 elements
Fixed: 2 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux 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 | |||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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 | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. ele-1: All FHIR elements must have a @value or children | ||||
medication[x] | SΣ | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne ele-1: All FHIR elements must have a @value or children | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Medication | ||||
subject | SΣ | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Patient | ||||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken 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 | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children | ||||
dose[x] | SΣ | 0..1 | Precise amount of medication per dose ele-1: All FHIR elements must have a @value or children | |||||
doseRange | Range(FrRangeUcum) | |||||||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
rate[x] | SΣ | 0..1 | Amount of medication per unit of time ele-1: All FHIR elements must have a @value or children | |||||
rateRatio | Ratio(FrRatioUcum) | |||||||
rateRange | Range(FrRangeUcum) | |||||||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
maxDosePerPeriod | SΣ | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time ele-1: All FHIR elements must have a @value or children | ||||
maxDosePerAdministration | SΣ | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit ele-1: All FHIR elements must have a @value or children | ||||
maxDosePerLifetime | SΣ | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.medication[x].type | extensible | Fixed Value: Medicationhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | Fixed Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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 MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux | |
meta | ||||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..1 | code | Language of the resource content | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
medication[x] | S | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Medication | |
identifier | 0..0 | |||
subject | S | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the medication |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Patient | |
informationSource | S | 0..0 | ||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
doseAndRate | ||||
dose[x] | S | 0..1 | Precise amount of medication per dose | |
doseRange | Range(FrRangeUcum) | |||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||
rate[x] | S | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio(FrRatioUcum) | |||
rateRange | Range(FrRangeUcum) | |||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||
maxDosePerPeriod | S | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time |
maxDosePerAdministration | S | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit |
maxDosePerLifetime | S | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Ligne de traitement médicamenteux du Bilan Médicamenteux | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statementSourcing | S | 0..1 | (Complex) | Sourcing de la ligne de traitement URL: https://hl7.fr/fhir/fr/medication/StructureDefinition/fr-medication-history-sources | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
medication[x] | SΣ | 1..1 | Reference(FrMedication) | Le médicament constitutif de cette ligne | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Medication | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
subject | SΣ | 1..1 | Reference(FR Core Patient Profile) | Who is/was taking the 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 | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Patient | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..* | Annotation | Further information about the statement | |||||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
dose[x] | SΣ | 0..1 | Precise amount of medication per dose | |||||
doseRange | Range(FrRangeUcum) | |||||||
doseQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
rate[x] | SΣ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio(FrRatioUcum) | |||||||
rateRange | Range(FrRangeUcum) | |||||||
rateQuantity | Quantity(FrSimpleQuantityUcum) | |||||||
maxDosePerPeriod | SΣ | 0..1 | FrRatioUcum | Upper precise limit on medication per unit of time | ||||
maxDosePerAdministration | SΣ | 0..1 | FrSimpleQuantityUcum | Precise upper limit on medication per administration with UCUM unit | ||||
maxDosePerLifetime | SΣ | 0..1 | FrSimpleQuantityUcum | A fixed measured or measurable amount with UCUM unit | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x].type | extensible | Fixed Value: Medicationhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | Fixed Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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 MedicationStatement
Summary
Mandatory: 1 element
Must-Support: 11 elements
Fixed: 2 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron