IHE Pharmacy Medication Overview
0.1.0 - ci-build
IHE Pharmacy Medication Overview, published by Integrating the Healthcare Enterprise (IHE). 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/IHE/pharm-meow/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationTreatmentLineLM | Version: 0.1.0 | |||
Active as of 2024-06-16 | Computable Name: MedicationTreatmentLineLM | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
Logical model for representing one line/medication in medication overview.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
@id | 0..1 | id | 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 |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
@id | 0..1 | id | 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 |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
@id | 0..1 | id | 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 |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
@id | 0..1 | id | 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 |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
@id | 0..1 | id | 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 |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 Base
Summary
Mandatory: 0 element(11 nested mandatory elements)
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationTreatmentLineLM | 0..* | Base | Medication Treatment Line (model) Instances of this logical model can be the target of a Reference | |
identifier | 0..* | II | Unique business identifier(s) for the medication treatment line | |
medication[x] | 1..1 | Medicinal product for which the treatment line refers to. Identification or sufficient description of the product. | ||
medicationElement | Element(CD) | |||
medicationReference | Reference(Medicinal product (model)) | |||
status | 1..1 | CD | Status of the treatment line entry | |
version | 0..1 | ST | Business version of the treatment line | |
timestamp | 0..1 | TS | Timestamp of the version of the treatment line | |
treatmentStatus | 0..1 | CD | The state of the actual treatment - taking, not taken... | |
treatmentStatusReasonCode | 0..1 | CD | The reason - coded - for the treatment status - i.e. adverse events, refusal... | |
treatmentStatusReasonText | 0..1 | ST | The reason - free text - for the treatment status - i.e. adverse events, refusal... | |
effectivePeriod | 0..1 | Class | The period of time the treatment is in effect | |
verificationInformation | 0..* | BackboneElement | Verification of medication line | |
@id | 0..1 | id | 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 |
verifier | 1..1 | Reference() | HCP (or device, if authorized) verifying the treatments/overview | |
verificationTime | 1..1 | DT | The date and time when this medication treatment line was verified | |
category | 0..* | CD | Whatever category for the treatment line. Categorisation of treatment lines is implementation-specific. | |
medicationTreatment | 0..* | Reference(Medication Treatment (model)) | Reference or identifier of the group of lines that belong together | |
indication | 0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
indicationText | 0..1 | string | Textual explanation for why the medication has been prescribed or why the patient is taking it. This might not be allowed by some implementations. | |
intendedUse | 0..1 | CD | Intended Use of the medication - prophylaxis, therapy... | |
usageInstructions | 0..* | DosagingInformation | Instructions about administration of the product | |
preparationInstructions | 0..* | string | Additional instructions about preparation or dispense | |
comment | 0..* | BackboneElement | Comment on the individual line | |
@id | 0..1 | id | 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 |
author | 1..1 | Reference() | Author of the comment (Pharmacist, doctor, social carer, patient, device, related person) | |
date | 1..1 | DT | time of comment | |
commentText | 1..1 | ST | content of the comment | |
substitution | 0..1 | Class | Whether and which type of substitution is allowed for this medication treatment line | |
@id | 0..1 | id | 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 |
substitutionType | 1..1 | CD | The type of substitution that is allowed. | |
substitutionTypeReason | 0..1 | CD | Coded reason for the substitution requirement | |
substitutionTypeReasonText | 0..1 | ST | Textual reason for the substitution requirement | |
recordingMetadata | 1..1 | Class | Metadata about reporting/authoring of the treatment line | |
@id | 0..1 | id | 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 |
recorder | 1..1 | Reference() | Person entering the statement by initiating a treatment or documenting a statement by a patient or another professional. The recorder may be different from the author. | |
recordedTime | 1..1 | DT | Time of creation of the treatment line | |
patientReported | 0..1 | BL | The treatment line has been documented according to patient's statement | |
responsibleAuthor | 0..1 | Reference(Practitioner (model)) | HCP who takes the clinical decision for the medication treatment line. If an author is not present, the responsibility of the medication line is with the recorder. | |
authoringTime | 0..1 | DT | The time the clinical decision was made by the responsibleAuthor. Normally, the same time as recording time when it's the same person. | |
derivedFrom | 0..* | Class | Any data object that this treatment line is derived from | |
@id | 0..1 | id | 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 |
request | 0..* | Reference() | Prescriptions that have been the source for creating the unverified treatment line | |
statement | 0..* | Reference() | Medication-related statements from patients, pharmacists, or other HCPs, that are the source for creating the unverified treatment line | |
dispensation | 0..* | Reference() | Related dispensations that are not necessarily related to existing prescriptions/requests/statements. | |
administration | 0..* | Reference() | Related administrations that are not necessarily related to existing prescriptions/requests/statements. | |
other | 0..* | Reference() | Other related sources of information - CarePlan, Immunizations, Documents (e.g. Discharge letters)... | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 Base
Summary
Mandatory: 0 element(11 nested mandatory elements)
Structures
This structure refers to these other structures: