IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record, published by Integrating the Healthcare Enterprise (IHE). This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/pharm-medo/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/MedRecordUsage | Version: 0.1.0 | |||
Active as of 2023-03-27 | Computable Name: MedRecordUsage | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
The profile for Medication Usage in a Medication Record - a record of a single administration event
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | recorded | entered-in-error | draft Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement. |
medication | Σ | 1..1 | CodeableReference(Medication) | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.status | required | MedicationStatementStatusCodes |
MedicationStatement.medication | example | SNOMEDCTMedicationCodes |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
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: AllLanguages (required): IETF language tag for 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 | External identifier |
partOf | 0..* | Reference(Procedure | MedicationStatement) | Part of referenced event | |
status | ?!Σ | 1..1 | code | recorded | entered-in-error | draft Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement. |
category | Σ | 0..* | CodeableConcept | Type of medication statement Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
medication | Σ | 1..1 | CodeableReference(Medication) | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with MedicationStatement |
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
dateAsserted | Σ | 0..1 | dateTime | When the usage was asserted? |
informationSource | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Link to information used to derive the MedicationStatement | |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Reason for why the medication is being/was taken Binding: ConditionProblemDiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
note | 0..* | Annotation | Further information about the usage | |
relatedClinicalInformation | 0..* | Reference(Observation | Condition) | Link to information relevant to the usage of a medication | |
renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
adherence | Σ | 0..1 | BackboneElement | Indicates whether the medication is or is not being consumed or administered |
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 |
code | Σ | 1..1 | CodeableConcept | Type of adherence Binding: MedicationStatementAdherenceCodes (example) |
reason | 0..1 | CodeableConcept | Details of the reason for the current use of the medication Binding: SNOMEDCTDrugTherapyStatusCodes (example) | |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.language | required | AllLanguages |
MedicationStatement.status | required | MedicationStatementStatusCodes |
MedicationStatement.category | example | MedicationRequestAdministrationLocationCodes |
MedicationStatement.medication | example | SNOMEDCTMedicationCodes |
MedicationStatement.reason | example | ConditionProblemDiagnosisCodes |
MedicationStatement.adherence.code | example | MedicationStatementAdherenceCodes |
MedicationStatement.adherence.reason | example | SNOMEDCTDrugTherapyStatusCodes |
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 MedicationStatement
Differential View
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | recorded | entered-in-error | draft Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement. |
medication | Σ | 1..1 | CodeableReference(Medication) | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.status | required | MedicationStatementStatusCodes |
MedicationStatement.medication | example | SNOMEDCTMedicationCodes |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
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: AllLanguages (required): IETF language tag for 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 | External identifier |
partOf | 0..* | Reference(Procedure | MedicationStatement) | Part of referenced event | |
status | ?!Σ | 1..1 | code | recorded | entered-in-error | draft Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement. |
category | Σ | 0..* | CodeableConcept | Type of medication statement Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
medication | Σ | 1..1 | CodeableReference(Medication) | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with MedicationStatement |
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
dateAsserted | Σ | 0..1 | dateTime | When the usage was asserted? |
informationSource | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Link to information used to derive the MedicationStatement | |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Reason for why the medication is being/was taken Binding: ConditionProblemDiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
note | 0..* | Annotation | Further information about the usage | |
relatedClinicalInformation | 0..* | Reference(Observation | Condition) | Link to information relevant to the usage of a medication | |
renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
adherence | Σ | 0..1 | BackboneElement | Indicates whether the medication is or is not being consumed or administered |
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 |
code | Σ | 1..1 | CodeableConcept | Type of adherence Binding: MedicationStatementAdherenceCodes (example) |
reason | 0..1 | CodeableConcept | Details of the reason for the current use of the medication Binding: SNOMEDCTDrugTherapyStatusCodes (example) | |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.language | required | AllLanguages |
MedicationStatement.status | required | MedicationStatementStatusCodes |
MedicationStatement.category | example | MedicationRequestAdministrationLocationCodes |
MedicationStatement.medication | example | SNOMEDCTMedicationCodes |
MedicationStatement.reason | example | ConditionProblemDiagnosisCodes |
MedicationStatement.adherence.code | example | MedicationStatementAdherenceCodes |
MedicationStatement.adherence.reason | example | SNOMEDCTDrugTherapyStatusCodes |
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 MedicationStatement
Other representations of profile: CSV, Excel, Schematron