MedicationDispense
This FHIR resource will be used to indicate that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
| MedicationDispense | C | MedicationDispense | There are no (further) constraints on this element Element idMedicationDispenseShort description Dispensing a medication to a named patient DefinitionIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedicationDispense.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedicationDispense.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idMedicationDispense.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idMedicationDispense.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| identifier | 1..* | Identifier | Element idMedicationDispense.identifierShort description External identifier DefinitionIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier. Unordered, Open, by $this(Value) Constraints
| |
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| recordIdentifier | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifierShort description External identifier DefinitionIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.identifier:recordIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/recordIdentifierExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.identifier:recordIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| dispenseID | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseIDShort description External identifier DefinitionIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.identifier:dispenseID.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/dispenseIDExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.identifier:dispenseID.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| sourceGroupingID | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingIDShort description External identifier DefinitionIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.identifier:sourceGroupingID.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/sourceGroupingIDExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.identifier:sourceGroupingID.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| basedOn | 0..0 | Reference(CarePlan) | There are no (further) constraints on this element Element idMedicationDispense.basedOnShort description Plan that is fulfilled by this dispense DefinitionA plan that is fulfilled in whole or in part by this MedicationDispense.
| |
| partOf | 0..0 | Reference(Procedure | MedicationAdministration) | There are no (further) constraints on this element Element idMedicationDispense.partOfShort description Event that dispense is part of DefinitionThe procedure or medication administration that triggered the dispense. While both a procedure and a medication administration may have triggered the dispense, but it is not expected that multiple procedures and/or multiple medication administrations would be triggers. Reference(Procedure | MedicationAdministration) Constraints
| |
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.statusShort description preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown DefinitionA code specifying the state of the set of dispense events. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Describes the lifecycle of the dispense. MedicationDispenseStatusCodes (required) Constraints
|
| notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReasonShort description Why a dispense was not performed DefinitionIndicates the reason why a dispense was not performed. CodeableReference(DetectedIssue) BindingMedicationDispenseStatusReasonCodes (example) Constraints
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| concept | Σ | 1..1 | CodeableConceptBinding | Element idMedicationDispense.notPerformedReason.conceptShort description Reference to a concept (by class) DefinitionA reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. https://fhir.synapxe.sg/ValueSet/status-reason (required) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.notPerformedReason.concept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/status-reasonMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.concept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| reference | Σ | 0..0 | Reference() | There are no (further) constraints on this element Element idMedicationDispense.notPerformedReason.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced.
|
| statusChanged | 0..0 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.statusChangedShort description When the status changed DefinitionThe date (and maybe time) when the status of the dispense record changed.
| |
| category | 0..1 | CodeableConceptBinding | Element idMedicationDispense.categoryShort description Type of medication dispense DefinitionIndicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind. A code describing where the dispensed medication is expected to be consumed or administered. https://fhir.synapxe.sg/ValueSet/dispense-type (required) Constraints
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.category.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.category.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedicationDispense.category.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.category.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.category.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.category.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/dispense-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationDispense.category.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.category.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.category.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.category.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.category.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| medication | Σ | 1..1 | CodeableReference(Medication) | Element idMedicationDispense.medicationShort description What medication was supplied DefinitionIdentifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. A coded concept identifying which substance or product can be dispensed. SNOMEDCTMedicationCodes (example) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.medication.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.medication.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| concept | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.medication.conceptShort description Reference to a concept (by class) DefinitionA reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.medication.concept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| reference | Σ | 0..0 | Reference() | There are no (further) constraints on this element Element idMedicationDispense.medication.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced.
|
| subject | Σ | 1..1 | Reference(Patient) | Element idMedicationDispense.subjectShort description Who the dispense is for DefinitionA link to a resource representing the person or the group to whom the medication will be given. SubstanceAdministration->subject->Patient.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.subject.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.subject.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationDispense.subject.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
PatientMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.subject.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| encounter | 0..1 | Reference(Encounter) | Element idMedicationDispense.encounterShort description Encounter associated with event DefinitionThe encounter that establishes the context for this event.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.encounter.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.encounter.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.encounter.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationDispense.encounter.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
EncounterMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.encounter.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/eventIDExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.encounter.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.encounter.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| supportingInformation | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idMedicationDispense.supportingInformationShort description Information that supports the dispensing of the medication DefinitionAdditional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.
| |
| performer | 1..1 | BackboneElement | There are no (further) constraints on this element Element idMedicationDispense.performerShort description Who performed event DefinitionIndicates who or what performed the event.
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.performer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.performer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.performer.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| function | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.performer.functionShort description Who performed the dispense and what they did DefinitionDistinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. Allows disambiguation of the types of involvement of different performers. A code describing the role an individual played in dispensing a medication. MedicationDispensePerformerFunctionCodes (example) Constraints
| |
| actor | 1..1 | Reference(Practitioner) | Element idMedicationDispense.performer.actorShort description Individual who was performing DefinitionThe device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationDispense.performer.actor.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
PractitionerMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.performer.actor.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/prnExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.performer.actor.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| location | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idMedicationDispense.locationShort description Where the dispense occurred DefinitionThe principal physical location where the dispense was performed.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.location.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.location.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.location.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationDispense.location.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
LocationMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.location.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.location.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/dispensing-locationExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.location.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.location.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| authorizingPrescription | 1..1 | Reference(MedicationRequest) | Element idMedicationDispense.authorizingPrescriptionShort description Medication order that authorizes the dispense DefinitionIndicates the medication order that is being dispensed against. Maps to basedOn in Event logical model.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationDispense.authorizingPrescription.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
MedicationRequestMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationDispense.authorizingPrescription.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/orderIDExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.authorizingPrescription.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| type | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.typeShort description Trial fill, partial fill, emergency fill, etc DefinitionIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. ActPharmacySupplyType http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType (example) Constraints
| |
| quantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationDispense.quantityShort description Amount dispensed DefinitionThe amount of medication that has been dispensed. Includes unit of measure.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.quantity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.quantity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idMedicationDispense.quantity.valueShort description Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
|
| comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.quantity.comparatorShort description < | <= | >= | > | ad - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
| unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.quantity.unitShort description Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
|
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.quantity.systemShort description System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.quantity.codeShort description Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| daysSupply | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationDispense.daysSupplyShort description Amount of medication expressed as a timing amount DefinitionThe amount of medication expressed as a timing amount.
| |
| recorded | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.recordedShort description When the recording of the dispense started DefinitionThe date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.
| |
| whenPrepared | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.whenPreparedShort description When product was packaged and reviewed DefinitionThe time when the dispensed product was packaged and reviewed. The cardinality or value of this element may be affected by these constraints: mdd-1 Constraints
|
| whenHandedOver | C | 0..0 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.whenHandedOverShort description When product was given out DefinitionThe time the dispensed product was provided to the patient or their representative. The cardinality or value of this element may be affected by these constraints: mdd-1 Constraints
|
| destination | 0..1 | Reference(Location) | Element idMedicationDispense.destinationShort description Where the medication was/will be sent DefinitionIdentification of the facility/location where the medication was/will be shipped to, as part of the dispense event.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.destination.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.destination.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.destination.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingPattern | Element idMedicationDispense.destination.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
LocationMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationDispense.destination.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriPattern | Element idMedicationDispense.destination.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/facilityunitExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationDispense.destination.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.destination.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| receiver | 0..0 | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | There are no (further) constraints on this element Element idMedicationDispense.receiverShort description Who collected the medication or where the medication was delivered DefinitionIdentifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location. Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) Constraints
| |
| note | 0..0 | Annotation | There are no (further) constraints on this element Element idMedicationDispense.noteShort description Information about the dispense DefinitionExtra information about the dispense that could not be conveyed in the other attributes.
| |
| renderedDosageInstruction | 0..0 | markdown | There are no (further) constraints on this element Element idMedicationDispense.renderedDosageInstructionShort description Full representation of the dosage instructions DefinitionThe full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
| |
| dosageInstruction | 1..1 | Dosage | There are no (further) constraints on this element Element idMedicationDispense.dosageInstructionShort description How the medication is to be used by the patient or administered by the caregiver DefinitionIndicates how the medication is to be used by the patient. When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| sequence | Σ | 1..1 | integer | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.sequenceShort description The order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted. If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.textShort description Free text dosage instructions e.g. SIG DefinitionFree text dosage instructions e.g. SIG. Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.
|
| additionalInstruction | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.additionalInstructionShort description Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" DefinitionSupplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text. A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". SNOMEDCTAdditionalDosageInstructions (example) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.additionalInstruction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.additionalInstruction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 0..0 | Coding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.additionalInstruction.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.additionalInstruction.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| patientInstruction | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.patientInstructionShort description Patient or consumer oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
|
| timing | Σ | 0..1 | Timing | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timingShort description When medication should be administered DefinitionWhen medication should be administered. The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| event | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
|
| repeat | Σ C | 0..1 | Element | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
| |
| boundsPeriod | Period | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.bounds[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.bounds[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| start | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.bounds[x].startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| end | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.bounds[x].endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| count | Σ C | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. The cardinality or value of this element may be affected by these constraints: tim-8 Constraints
|
| countMax | Σ C | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. The cardinality or value of this element may be affected by these constraints: tim-8 Constraints
|
| duration | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). The cardinality or value of this element may be affected by these constraints: tim-7, tim-1, tim-4 Constraints
|
| durationMax | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). The cardinality or value of this element may be affected by these constraints: tim-7 Constraints
|
| durationUnit | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. A unit of time (units from UCUM). The cardinality or value of this element may be affected by these constraints: tim-1 Constraints
|
| frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.frequencyShort description Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
| frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
|
| period | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.periodShort description The duration to which the frequency applies. I.e. Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. The cardinality or value of this element may be affected by these constraints: tim-6, tim-5, tim-2 Constraints
|
| periodMax | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. The cardinality or value of this element may be affected by these constraints: tim-6 Constraints
|
| periodUnit | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.periodUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. A unit of time (units from UCUM). The cardinality or value of this element may be affected by these constraints: tim-2 Constraints
|
| dayOfWeek | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified.
|
| timeOfDay | Σ C | 0..1 | time | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa. The cardinality or value of this element may be affected by these constraints: tim-10 Constraints
|
| when | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real-world event relating to the schedule. The cardinality or value of this element may be affected by these constraints: tim-9, tim-10 Constraints
|
| offset | Σ C | 0..1 | unsignedInt | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. The cardinality or value of this element may be affected by these constraints: tim-9 Constraints
|
| code | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.codeShort description C | BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. TimingAbbreviation (preferred) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.timing.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| asNeeded | Σ C | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededShort description Take "as needed" DefinitionIndicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option). Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. The cardinality or value of this element may be affected by these constraints: dos-1 Constraints
|
| asNeededFor | Σ C | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededForShort description Take "as needed" (for x) DefinitionIndicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept). Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed". A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: dos-1 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededFor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededFor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 0..0 | Coding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededFor.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.asNeededFor.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| site | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.siteShort description Body site to administer to DefinitionBody site to administer to. A coded specification of the anatomic site where the medication first enters the body. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. A coded concept describing the site location the medicine enters into or onto the body. SNOMEDCTAnatomicalStructureAdministrationSites (example) Constraints
|
| route | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.routeShort description How drug should enter body DefinitionHow drug should enter body. A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.route.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| method | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.methodShort description Technique for administering medication DefinitionTechnique for administering medication. A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. Terminologies used often pre-coordinate this term with the route and or form of administration. A coded concept describing the technique by which the medicine is administered. SNOMEDCTAdministrationMethodCodes (example) Constraints
|
| doseAndRate | Σ | 0..* | Element | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRateShort description Amount of medication administered, to be administered or typical amount to be administered DefinitionDepending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRate.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRate.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| type | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRate.typeShort description The kind of dose or rate specified DefinitionThe kind of dose or rate specified, for example, ordered or calculated. If the type is not populated, assume to be "ordered". The kind of dose or rate specified. http://terminology.hl7.org/ValueSet/dose-rate-type (example) Constraints
|
| dose[x] | Σ | 1..1 | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRate.dose[x]Short description Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
| |
| doseRange | Range | There are no (further) constraints on this element Data type | ||
| doseQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
| rate[x] | Σ | 0..0 | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.doseAndRate.rate[x]Short description Amount of medication per unit of time DefinitionAmount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
| |
| maxDosePerPeriod | Σ | 0..0 | Ratio | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.maxDosePerPeriodShort description Upper limit on medication per unit of time DefinitionUpper limit on medication per unit of time. The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
|
| maxDosePerAdministration | Σ | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.maxDosePerAdministrationShort description Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
|
| maxDosePerLifetime | Σ | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationDispense.dosageInstruction.maxDosePerLifetimeShort description Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
|
| substitution | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMedicationDispense.substitutionShort description Whether a substitution was performed on the dispense DefinitionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
| |
| eventHistory | 0..0 | Reference(Provenance) | There are no (further) constraints on this element Element idMedicationDispense.eventHistoryShort description A list of relevant lifecycle events DefinitionA summary of the events of interest that have occurred, such as when the dispense was verified. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
|
| Medication | C | Medication | There are no (further) constraints on this element Element idMedicationShort description Definition of a Medication DefinitionThis resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedication.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedication.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedication.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedication.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idMedication.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idMedication.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| identifier | Σ | 0..0 | Identifier | Element idMedication.identifierShort description Business identifier for this medication DefinitionBusiness identifier for this medication. The serial number could be included as an identifier. Unordered, Open, by $this(Value) Constraints
|
| code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idMedication.codeShort description Codes that identify this medication DefinitionA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). A coded concept that defines the type of a medication. SNOMEDCTMedicationCodes (example) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idMedication.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriPattern | Element idMedication.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/sdd-medicationcodesMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedication.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | codeBinding | Element idMedication.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. https://fhir.synapxe.sg/ValueSet/sdd-medicationcodes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedication.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedication.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedication.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| status | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedication.statusShort description active | inactive | entered-in-error DefinitionA code to indicate if the medication is in active use. This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. A coded concept defining if the medication is in active use. MedicationStatusCodes (required) Constraints
|
| marketingAuthorizationHolder | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedication.marketingAuthorizationHolderShort description Organization that has authorization to market medication DefinitionThe company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).
|
| doseForm | 0..1 | CodeableConceptBinding | Element idMedication.doseFormShort description powder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. A coded concept defining the form of a medication.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.doseForm.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.doseForm.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedication.doseForm.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.doseForm.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.doseForm.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriPattern | Element idMedication.doseForm.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://hl7.org/fhir/CodeSystem/medication-form-codesMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedication.doseForm.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | codeBinding | Element idMedication.doseForm.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedication.doseForm.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedication.doseForm.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedication.doseForm.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| totalVolume | Σ | 0..0 | Quantity | There are no (further) constraints on this element Element idMedication.totalVolumeShort description When the specified product code does not infer a package size, this is the specific amount of drug in the product DefinitionWhen the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
|
| ingredient | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMedication.ingredientShort description Active or inactive ingredient DefinitionIdentifies a particular constituent of interest in the product. The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedication.ingredient.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| item | 1..1 | CodeableReference(Medication) | Element idMedication.ingredient.itemShort description The ingredient (substance or medication) that the ingredient.strength relates to DefinitionThe ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication). The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). SNOMEDCTMedicationCodes (example) Constraints
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.ingredient.item.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.item.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| concept | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idMedication.ingredient.item.conceptShort description Reference to a concept (by class) DefinitionA reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedication.ingredient.item.concept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/sdd-medicationcodesMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | codeBinding | Element idMedication.ingredient.item.concept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. https://fhir.synapxe.sg/ValueSet/sdd-medicationcodes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedication.ingredient.item.concept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| reference | Σ | 0..0 | Reference() | There are no (further) constraints on this element Element idMedication.ingredient.item.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced.
|
| isActive | 0..0 | boolean | There are no (further) constraints on this element Element idMedication.ingredient.isActiveShort description Active ingredient indicator DefinitionIndication of whether this ingredient affects the therapeutic action of the drug. True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).
| |
| strength[x] | 1..1 | Binding | There are no (further) constraints on this element Element idMedication.ingredient.strength[x]Short description Quantity of ingredient present DefinitionSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet. A coded concpet defining the strength of an ingredient. MedicationIngredientStrengthCodes (preferred) Constraints
| |
| strengthQuantity | Quantity | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idMedication.ingredient.strength[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedication.ingredient.strength[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idMedication.ingredient.strength[x].valueShort description Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
|
| comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedication.ingredient.strength[x].comparatorShort description < | <= | >= | > | ad - how to understand the value DefinitionHow the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
| unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedication.ingredient.strength[x].unitShort description Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
|
| system | Σ C | 1..1 | uriPattern | Element idMedication.ingredient.strength[x].systemShort description System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
http://hl7.org/fhir/CodeSystem/medication-ingredientstrengthMappings
|
| code | Σ C | 1..1 | codeBinding | Element idMedication.ingredient.strength[x].codeShort description Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. MedicationIngredientStrengthCodes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| batch | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMedication.batchShort description Details about packaged medications DefinitionInformation that only applies to packages (not products).
| |
| definition | 0..0 | Reference(MedicationKnowledge) | There are no (further) constraints on this element Element idMedication.definitionShort description Knowledge about this medication DefinitionA reference to a knowledge resource that provides more information about this medication. Reference(MedicationKnowledge) Constraints
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| MedicationDispense.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| MedicationDispense.status | required | http://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 | Describes the lifecycle of the dispense. |
| MedicationDispense.notPerformedReason | example | http://hl7.org/fhir/ValueSet/medicationdispense-status-reason | |
| MedicationDispense.notPerformedReason.concept | required | https://fhir.synapxe.sg/ValueSet/status-reason | |
| MedicationDispense.category | required | https://fhir.synapxe.sg/ValueSet/dispense-type | A code describing where the dispensed medication is expected to be consumed or administered. |
| MedicationDispense.medication | example | http://hl7.org/fhir/ValueSet/medication-codes | A coded concept identifying which substance or product can be dispensed. |
| MedicationDispense.medication.reference.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.subject.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.encounter.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.performer.actor.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.location.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.authorizingPrescription.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.destination.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.dosageInstruction.additionalInstruction | example | http://hl7.org/fhir/ValueSet/additional-instruction-codes | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| MedicationDispense.dosageInstruction.timing.repeat.durationUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|5.0.0 | A unit of time (units from UCUM). |
| MedicationDispense.dosageInstruction.timing.repeat.periodUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|5.0.0 | A unit of time (units from UCUM). |
| MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek | required | http://hl7.org/fhir/ValueSet/days-of-week|5.0.0 | |
| MedicationDispense.dosageInstruction.timing.repeat.when | required | http://hl7.org/fhir/ValueSet/event-timing|5.0.0 | Real-world event relating to the schedule. |
| MedicationDispense.dosageInstruction.timing.code | preferred | http://hl7.org/fhir/ValueSet/timing-abbreviation | Code for a known / defined timing pattern. |
| MedicationDispense.dosageInstruction.asNeededFor | example | http://hl7.org/fhir/ValueSet/medication-as-needed-reason | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. |
| MedicationDispense.dosageInstruction.route | example | http://hl7.org/fhir/ValueSet/route-codes | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
| MedicationDispense.substitution.type | example | http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ActSubstanceAdminSubstitutionCode |
| MedicationDispense.substitution.reason | example | http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason | SubstanceAdminSubstitutionReason |
XML to FHIR Mapping
| XML element | FHIR mapping |
|---|---|
| medicationDispense/recordIdentifier | MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/recordIdentifier).value |
| medicationDispense/eventID | MedicationDispense.encounter.identifier(system=https://fhir.synapxe.sg/NamingSystem/eventID).value |
| medicationDispense/orderID | MedicationDispense.authorizingPrescription.identifier(system=https://fhir.synapxe.sg/NamingSystem/orderID).value |
| medicationDispense/sourceGroupingID | MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/sourceGroupingID).value |
| medicationDispense/orderingInstitution | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingInstitution |
| medicationDispense/orderingLocation | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.code |
| medicationDispense/orderingLocation/codingSchemeName | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.system |
| medicationDispense/orderingLocation/codingSchemeVersion | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.version |
| medicationDispense/orderingLocation/textDescription | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.display |
| medicationDispense/recordCreatedDateTime | MedicationDispense.recorded |
| medicationDispense/orderedBy/id | MedicationDispense.authorizingPrescription(MedicationRequest).requester.identifier.value |
| medicationDispense/orderedBy/name | MedicationDispense.authorizingPrescription(MedicationRequest).requester.display |
| medicationDispense/dispenseID | MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/dispenseID).value |
| medicationDispense/dispensingInstitution | MedicationDispense.extension:dispensingInstitution |
| medicationDispense/dispensingLocation/code | MedicationDispense.location.identifier(system=https://fhir.synapxe.sg/NamingSystem/dispensing-location).value |
| medicationDispense/dispensingLocation/textDescription | MedicationDispense.location.display |
| medicationDispense/dispenseType/code | MedicationDispense.category.coding.code |
| medicationDispense/dispenseType/codingSchemeName | MedicationDispense.category.coding.system |
| medicationDispense/dispenseType/codingSchemeVersion | MedicationDispense.category.coding.version |
| medicationDispense/dispenseType/textDescription | MedicationDispense.category.coding.display |
| medicationDispense/dispenseDateTime | MedicationDispense.whenPrepared |
| medicationDispense/reasonForCancellation/code | MedicationDispense.notPerformedReason.concept.coding.code |
| medicationDispense/reasonForCancellation/codingSchemeName | MedicationDispense.notPerformedReason.concept.coding.system |
| medicationDispense/reasonForCancellation/codingSchemeVersion | MedicationDispense.notPerformedReason.concept.coding.version |
| medicationDispense/reasonForCancellation/textDescription | MedicationDispense.notPerformedReason.concept.coding.display |
| medicationDispense/dispenseStatus/code | MedicationDispense.status.coding.code |
| medicationDispense/dispenseStatus/codingSchemeName | MedicationDispense.status.coding.system |
| medicationDispense/dispenseStatus/codingSchemeVersion | MedicationDispense.status.coding.version |
| medicationDispense/dispenseStatus/textDescription | MedicationDispense.status.coding.display |
| medicationDispense/dispensedBy/id | MedicationDispense.performer.actor.identifier.value |
| medicationDispense/dispensedBy/name | MedicationDispense.performer.actor.display |
| medicationDispense/authorizedBy/id | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:authorizer.identifier.value |
| medicationDispense/authorizedBy/name | MedicationDispense.authorizingPrescription(MedicationRequest).extensions:authorizer.display |
| medicationDispense/medicationItem | MedicationDispense.medication(Medication) |
| medicationDispense/medicationItem/itemId | Medication.identifier(system=https://fhir.synapxe.sg/NamingSystem/itemID).value |
| medicationDispense/medicationItem/sequenceNo | MedicationDispense.extensions:sequenceNo |
| medicationDispense/medicationItem/groupNo | MedicationDispense.extensions:groupNo |
| medicationDispense/medicationItem/groupSequenceNo | MedicationDispense.dosageInstruction.sequence |
| medicationDispense/medicationItem/orderSetConnectingTerm | MedicationDispense.extension:orderSetConnectingTerm |
| medicationDispense/medicationItem/frequencyQualifier | MedicationDispense.dosageInstruction.additionalInstruction.text |
| medicationDispense/medicationItem/dosageInstruction | MedicationDispense.dosageInstruction.text |
| medicationDispense/medicationItem/doseQuantity/lowValue | MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.lowValue |
| medicationDispense/medicationItem/doseQuantity/lowUnit | MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.lowUnit |
| medicationDispense/medicationItem/doseQuantity/highValue | MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.highValue |
| medicationDispense/medicationItem/doseQuantity/highUnit | MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.highUnit |
| medicationDispense/medicationItem/medicationItemDispensedDate | MedicationDispense.whenPrepared |
| medicationDispense/medicationItem/medicationStartDateTime | MedicationDispense.authorizingPrescription(MedicationRequest) |
| medicationDispense/medicationItem/medicationEndDateTime | MedicationDispense.authorizingPrescription(MedicationRequest) |
| medicationDispense/medicationItem/medicationItemStatus/code | Medication.status.coding.code |
| medicationDispense/medicationItem/medicationItemStatus/codingSchemeName | Medication.status.coding.system |
| medicationDispense/medicationItem/medicationItemStatus/codingSchemeVersion | Medication.status.coding.version |
| medicationDispense/medicationItem/medicationItemStatus/textDescription | Medication.status.coding.display |
| medicationDispense/medicationItem/reasonForMedication/code | MedicationDispense.reason.concept.coding.code |
| medicationDispense/medicationItem/reasonForMedication/codingSchemeName | MedicationDispense.reason.concept.coding.system |
| medicationDispense/medicationItem/reasonForMedication/codingSchemeVersion | MedicationDispense.reason.concept.coding.version |
| medicationDispense/medicationItem/reasonForMedication/textDescription | MedicationDispense.reason.concept.coding.display |
| medicationDispense/medicationItem/changesMade/code | MedicationDispense.extension:changesMade.code |
| medicationDispense/medicationItem/changesMade/codingSchemeName | MedicationDispense.extension:changesMade.system |
| medicationDispense/medicationItem/changesMade/codingSchemeVersion | MedicationDispense.extension:changesMade.version |
| medicationDispense/medicationItem/changesMade/textDescription | MedicationDispense.extension:changesMade.display |
| medicationDispense/medicationItem/reasonForChanges/code | MedicationDispense.notPerformedReason.concept.coding.code |
| medicationDispense/medicationItem/reasonForChanges/codingSchemeName | MedicationDispense.notPerformedReason.concept.coding.system |
| medicationDispense/medicationItem/reasonForChanges/codingSchemeVersion | MedicationDispense.notPerformedReason.concept.coding.version |
| medicationDispense/medicationItem/reasonForChanges/textDescription | MedicationDispense.notPerformedReason.concept.coding.display |
| medicationDispense/medicationItem/quantityDispensed | MedicationDispense.quantity.value |
| medicationDispense/medicationItem/quantityDispensedUnits | MedicationDispense.quantity.unit |
| medicationDispense/medicationItem/duration/code | MedicationDispense.dosageInstruction.timing.repeat.period |
| medicationDispense/medicationItem/durationUnits | MedicationDispense.dosageInstruction.timing.repeat.periodUnit |
| medicationDispense/medicationItem/medicationName/code | Medication.code.coding.code |
| medicationDispense/medicationItem/medicationName/codingSchemeName | Medication.code.coding.system |
| medicationDispense/medicationItem/medicationName/codingSchemeVersion | Medication.code.coding.version |
| medicationDispense/medicationItem/medicationName/textDescription | Medication.code.coding.display |
| medicationDispense/medicationItem/frequency/code | MedicationDispense.dosageInstruction.timing.repeat.when.coding.code |
| medicationDispense/medicationItem/frequency/codingSchemeName | MedicationDispense.dosageInstruction.timing.repeat.when.coding.system |
| medicationDispense/medicationItem/frequency/codingSchemeVersion | MedicationDispense.dosageInstruction.timing.repeat.when.coding.version |
| medicationDispense/medicationItem/frequency/textDescription | MedicationDispense.dosageInstruction.timing.repeat.when.coding.display |
| medicationDispense/medicationItem/routeOfAdministration/code | MedicationDispense.dosageInstruction.route.coding.code |
| medicationDispense/medicationItem/routeOfAdministration/codingSchemeName | MedicationDispense.dosageInstruction.route.coding.system |
| medicationDispense/medicationItem/routeOfAdministration/codingSchemeVersion | MedicationDispense.dosageInstruction.route.coding.version |
| medicationDispense/medicationItem/routeOfAdministration/textDescription | MedicationDispense.dosageInstruction.route.coding.display |
| medicationDispense/medicationItem/medicationStrength | Medication.ingredient.strengthQuantity.value |
| medicationDispense/medicationItem/medicationStrengthUnit | Medication.ingredient.strengthQuantity.unit |
| medicationDispense/medicationItem/doseForm/code | Medication.doseForm.coding.code |
| medicationDispense/medicationItem/doseForm/codingSchemeName | Medication.doseForm.coding.system |
| medicationDispense/medicationItem/doseForm/codingSchemeVersion | Medication.doseForm.coding.version |
| medicationDispense/medicationItem/doseForm/textDescription | Medication.doseForm.coding.display |