OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build
OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build
OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-medication | Version: 0.1.0 | |||
| Active as of 2023-03-20 | Computable Name: OMRSMedication | |||
A FHIR Medication Resource as understood by OpenMRS
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | 0..* | Medication | Definition of a Medication | |
  id | 1..1 | id | Logical id of this artifact | |
| code | 0..1 | CodeableConcept | Codes that identify this medication | |
| status | 0..1 | code | active | inactive | entered-in-error | |
| manufacturer | 0..0 | |||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + | |
| amount | 0..0 | |||
| ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |
 batch | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
 id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 code | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
 ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 item[x] | 1..1 | The actual ingredient or content | ||
| itemCodeableConcept | CodeableConcept | |||
 itemReference | Reference(Substance | Medication) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Medication.code | example | SNOMEDCTMedicationCodes |
| Medication.status | required | Medication Status Codes |
| Medication.form | example | SNOMEDCTFormCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |||||
| id | Σ | 1..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
 item[x] | 1..1 | The actual ingredient or content | ||||||
 itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(Substance | Medication) | |||||||
| isActive | 0..1 | boolean | Active ingredient indicator | |||||
| strength | 0..1 | Ratio | Quantity of ingredient present | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Medication.language | preferred | CommonLanguages
| ||||
| Medication.code | example | SNOMEDCTMedicationCodes | ||||
| Medication.status | required | Medication Status Codes | ||||
| Medication.form | example | SNOMEDCTFormCodes |
| 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 Medication
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
| id | 1..1 | id | Logical id of this artifact | |
| code | 0..1 | CodeableConcept | Codes that identify this medication | |
| status | 0..1 | code | active | inactive | entered-in-error | |
| manufacturer | 0..0 | |||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + | |
| amount | 0..0 | |||
| ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |
| batch | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
| id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
| ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| item[x] | 1..1 | The actual ingredient or content | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | Medication) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Medication.code | example | SNOMEDCTMedicationCodes |
| Medication.status | required | Medication Status Codes |
| Medication.form | example | SNOMEDCTFormCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |||||
| id | Σ | 1..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| ingredient | 0..1 | BackboneElement | Active or inactive ingredient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item[x] | 1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(Substance | Medication) | |||||||
| isActive | 0..1 | boolean | Active ingredient indicator | |||||
| strength | 0..1 | Ratio | Quantity of ingredient present | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Medication.language | preferred | CommonLanguages
| ||||
| Medication.code | example | SNOMEDCTMedicationCodes | ||||
| Medication.status | required | Medication Status Codes | ||||
| Medication.form | example | SNOMEDCTFormCodes |
| 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 Medication
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ . Package openmrs#0.1.0 based on FHIR 4.0.1. Generated 2023-03-20
Links: Table of Contents |
QA Report |
Version History |
|