openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-medication | Version: 1.0.0 | |||
Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: OpenIMISMedication |
Defines a Medication for openIMIS which maps to a Medical Item.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
id | 0..1 | string | Medication UUID | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-usage-context | 0..4 | (Complex) | Usage Context URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-usage-context | |
unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |
medication-frequency | 0..1 | Timing | Frequency URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency | |
medication-type | 1..1 | CodeableConcept | Medication Type URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-type Binding: Item Type (Medication) (required) | |
medication-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level Binding: Level (Medication) (required) | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/medication-level | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: M | |
display | 1..1 | string | Representation defined by the system Fixed Value: Medication | |
Slices for identifier | S | 1..* | Identifier | Business identifier for this medication Slice: Unordered, Closed by value:type.coding.code |
identifier:All Slices | Content/Rules for all slices | |||
type | 1..1 | CodeableConcept | Description of identifier | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
value | 1..1 | string | The value that is unique | |
identifier:Code | S | 1..1 | Identifier | Business identifier for this medication |
type | ||||
coding | ||||
code | 1..1 | code | Medication openIMIS Code Required Pattern: Code | |
identifier:UUID | 0..1 | Identifier | Business identifier for this medication | |
type | ||||
coding | ||||
code | 1..1 | code | Medication openIMIS UUID Required Pattern: UUID | |
code | 1..1 | CodeableConcept | Codes that identify this medication | |
text | 1..1 | string | Medication name | |
status | 0..1 | code | Active Status Required Pattern: active | |
manufacturer | 0..0 | |||
form | 0..1 | CodeableConcept | Medication Form | |
amount | ||||
numerator | 1..1 | Quantity | Numerator value | |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
denominator | 0..0 | |||
ingredient | 0..0 | |||
batch | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
id | Σ | 0..1 | string | Medication UUID | ||||
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 | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medication-usage-context | 0..4 | (Complex) | Usage Context URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-usage-context | |||||
unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |||||
medication-frequency | 0..1 | Timing | Frequency URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency | |||||
medication-type | 1..1 | CodeableConcept | Medication Type URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-type Binding: Item Type (Medication) (required) | |||||
medication-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level Binding: Level (Medication) (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Level (Medication) (required) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/medication-level | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: M | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Medication | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | Business identifier for this medication Slice: Unordered, Closed by value:type.coding.code | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:Code | SΣ | 1..1 | Identifier | Business identifier for this 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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Medication openIMIS Code Required Pattern: Code | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:UUID | Σ | 0..1 | Identifier | Business identifier for this 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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Medication openIMIS UUID Required Pattern: UUID | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
code | Σ | 1..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Medication name | ||||
status | ?!Σ | 0..1 | code | Active Status Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. Required Pattern: active | ||||
form | 0..1 | CodeableConcept | Medication Form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 1..1 | Quantity | Numerator value | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣI | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
Slices for identifier | Σ | 1..* | Identifier | Business identifier for this medication Slice: Unordered, Closed by value:type.coding.code |
identifier:Code | Σ | 1..1 | Identifier | Business identifier for this medication |
Documentation for this format |
This structure is derived from Medication
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
id | 0..1 | string | Medication UUID | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-usage-context | 0..4 | (Complex) | Usage Context URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-usage-context | |
unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |
medication-frequency | 0..1 | Timing | Frequency URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency | |
medication-type | 1..1 | CodeableConcept | Medication Type URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-type Binding: Item Type (Medication) (required) | |
medication-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level Binding: Level (Medication) (required) | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/medication-level | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: M | |
display | 1..1 | string | Representation defined by the system Fixed Value: Medication | |
Slices for identifier | S | 1..* | Identifier | Business identifier for this medication Slice: Unordered, Closed by value:type.coding.code |
identifier:All Slices | Content/Rules for all slices | |||
type | 1..1 | CodeableConcept | Description of identifier | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
value | 1..1 | string | The value that is unique | |
identifier:Code | S | 1..1 | Identifier | Business identifier for this medication |
type | ||||
coding | ||||
code | 1..1 | code | Medication openIMIS Code Required Pattern: Code | |
identifier:UUID | 0..1 | Identifier | Business identifier for this medication | |
type | ||||
coding | ||||
code | 1..1 | code | Medication openIMIS UUID Required Pattern: UUID | |
code | 1..1 | CodeableConcept | Codes that identify this medication | |
text | 1..1 | string | Medication name | |
status | 0..1 | code | Active Status Required Pattern: active | |
manufacturer | 0..0 | |||
form | 0..1 | CodeableConcept | Medication Form | |
amount | ||||
numerator | 1..1 | Quantity | Numerator value | |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
denominator | 0..0 | |||
ingredient | 0..0 | |||
batch | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
id | Σ | 0..1 | string | Medication UUID | ||||
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 | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medication-usage-context | 0..4 | (Complex) | Usage Context URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-usage-context | |||||
unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |||||
medication-frequency | 0..1 | Timing | Frequency URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency | |||||
medication-type | 1..1 | CodeableConcept | Medication Type URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-type Binding: Item Type (Medication) (required) | |||||
medication-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level Binding: Level (Medication) (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-level" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Level (Medication) (required) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/medication-level | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: M | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Medication | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | Business identifier for this medication Slice: Unordered, Closed by value:type.coding.code | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:Code | SΣ | 1..1 | Identifier | Business identifier for this 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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Medication openIMIS Code Required Pattern: Code | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:UUID | Σ | 0..1 | Identifier | Business identifier for this 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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Medication openIMIS UUID Required Pattern: UUID | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
code | Σ | 1..1 | CodeableConcept | Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Medication name | ||||
status | ?!Σ | 0..1 | code | Active Status Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. Required Pattern: active | ||||
form | 0..1 | CodeableConcept | Medication Form Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 1..1 | Quantity | Numerator value | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣI | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Medication.language | preferred | CommonLanguages Max Binding: AllLanguages |
Medication.extension:level.value[x]:valueCodeableConcept | required | Pattern: M("Medication") |
Medication.identifier.use | required | IdentifierUse |
Medication.identifier.type | extensible | Identifier Type Codes |
Medication.identifier.type.coding.code | required | OpenIMISIdentifierVS |
Medication.identifier:Code.use | required | IdentifierUse |
Medication.identifier:Code.type | extensible | Identifier Type Codes |
Medication.identifier:UUID.use | required | IdentifierUse |
Medication.identifier:UUID.type | extensible | Identifier Type Codes |
Medication.code | example | SNOMEDCTMedicationCodes |
Medication.status | required | Pattern: active |
Medication.form | example | SNOMEDCTFormCodes |
Medication.amount.numerator.comparator | required | QuantityComparator |
Id | Grade | Path | 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 | Medication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension:useContext | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:unitPrice | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension:unitPrice | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:timing | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension:timing | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension:type | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:level | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.extension:level | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.extension:level.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.extension:level.value[x]:valueCodeableConcept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:Code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:Code.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:Code.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:Code.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:Code.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:Code.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:Code.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:UUID.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:UUID.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:UUID.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:UUID.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.identifier:UUID.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.identifier:UUID.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.identifier:UUID.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.form | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.amount.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.amount.numerator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.numerator.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.amount.numerator.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.amount.numerator.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.numerator.comparator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.numerator.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.numerator.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.amount.numerator.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.ingredient.item[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.ingredient.isActive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.ingredient.strength | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.batch.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.batch.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.batch.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Medication.batch.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Medication.batch.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Medication.batch.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |