Ballerina library

health.fhir.r4.be.medication100

Module health.fhir.r4.be.medication100

Package OverviewCapabilities and features

API

initialize

Declarations

PROFILE_BASE_BEMEDICATIONDISPENSE
RESOURCE_NAME_BEMEDICATIONDISPENSE

BeMedicationDispenseContextIdentifierUse
BeMedicationDispenseIdentifierUse
BeMedicationDispenseStatus

terminologyProcessor
fhirRegistry
FHIR_VALUE_SETS
FHIR_CODE_SYSTEMS

Definitions

BeMedicationDispense
BeMedicationDispenseAuthorizingPrescription
BeMedicationDispenseContext
BeMedicationDispenseContextIdentifier
BeMedicationDispenseDosageInstruction
BeMedicationDispenseIdentifierDGUID
BeMedicationDispensePerformer
BeMedicationDispenseSubstitution

ballerinax/health.fhir.r4.be.medication100 Ballerina library

1.0.0

Ballerina package containing FHIR resource data models compliant with https://www.ehealth.fgov.be/standards/fhir/medication/ implementation guide.

FHIR R4 health_fhir_r4_be_medication100 package

Package Overview

FHIR versionR4
Implementation Guidehttps://www.ehealth.fgov.be/standards/fhir/medication/

Note: This package only supports FHIR JSON payload format only. FHIR XML payload support will be added soon.

Capabilities and features

Supported FHIR resource types

1). BeMedicationDispense[Definition] [Ballerina Record]

Functions

initialize

Isolated Function
function initialize()

This empty function is used to initialize the module by other modules/packages.

Constants

health.fhir.r4.be.medication100: PROFILE_BASE_BEMEDICATIONDISPENSE

string "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-medicationdispense"

health.fhir.r4.be.medication100: RESOURCE_NAME_BEMEDICATIONDISPENSE

string "MedicationDispense"

Enums

health.fhir.r4.be.medication100: BeMedicationDispenseContextIdentifierUse

BeMedicationDispenseContextIdentifierUse enum

Members

CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL

health.fhir.r4.be.medication100: BeMedicationDispenseIdentifierUse

BeMedicationDispenseIdentifierUse enum

Members

CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL

health.fhir.r4.be.medication100: BeMedicationDispenseStatus

BeMedicationDispenseStatus enum

Members

CODE_STATUS_STOPPED
CODE_STATUS_DECLINED
CODE_STATUS_CANCELLED
CODE_STATUS_COMPLETED
CODE_STATUS_ENTERED_IN_ERROR
CODE_STATUS_IN_PROGRESS
CODE_STATUS_ON_HOLD
CODE_STATUS_PREPARATION
CODE_STATUS_UNKNOWN

Variables

health.fhir.r4.be.medication100: terminologyProcessor

TerminologyProcessor(default r4:terminologyProcessor)

Terminology processor instance

health.fhir.r4.be.medication100: fhirRegistry

FHIRRegistry(default r4:fhirRegistry)

FHIR registry instance

health.fhir.r4.be.medication100: FHIR_VALUE_SETS

json[](default [])

health.fhir.r4.be.medication100: FHIR_CODE_SYSTEMS

json[](default [])

Records

health.fhir.r4.be.medication100: BeMedicationDispense

FHIR BeMedicationDispense resource record.

Fields
  • note? Annotation[] - Extra information about the dispense that could not be conveyed in the other attributes.
  • partOf? Reference[] - The procedure that trigger the dispense.
  • extension? Extension[] - May 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 manageable, 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.
  • substitution? BeMedicationDispenseSubstitution - Indicates 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.
  • subject Reference - A link to a resource representing the person or the group to whom the medication will be given.
  • modifierExtension? Extension[] - May 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 manageable, 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).
  • destination? Reference - Identification of the facility/location where the medication was shipped to, as part of the dispense event.
  • language? code - The base language in which the resource is written.
  • statusReasonReference? Reference - Indicates the reason why a dispense was not performed.
  • statusReasonCodeableConcept? CodeableConcept - Indicates the reason why a dispense was not performed.
  • 'type? CodeableConcept - Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
  • medicationReference? Reference - Identifies the medication being administered. 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.
  • id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
  • text? Narrative - A 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.
  • identifier? Identifier[] - Identifiers 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.
    • identifier Slicings
    1. BeMedicationDispenseIdentifierDGUID: External identifier
    • min = 0
    • max = 1
  • quantity? SimpleQuantity - The amount of medication that has been dispensed. Includes unit of measure.
  • detectedIssue? Reference[] - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
  • receiver? Reference[] - Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
  • whenPrepared? dateTime - The time when the dispensed product was packaged and reviewed.
  • daysSupply? SimpleQuantity - The amount of medication expressed as a timing amount.
  • supportingInformation? Reference[] - Additional information that supports the medication being dispensed.
  • whenHandedOver dateTime - The time the dispensed product was provided to the patient or their representative.
  • medicationCodeableConcept? CodeableConcept - Identifies the medication being administered. 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.
  • contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
  • meta? Meta - The 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.
  • eventHistory? Reference[] - A summary of the events of interest that have occurred, such as when the dispense was verified.
  • implicitRules? uri - A 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.
  • location? Reference - The principal physical location where the dispense was performed.
  • category? CodeableConcept - Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
  • Element... - Rest field

health.fhir.r4.be.medication100: BeMedicationDispenseAuthorizingPrescription

Closed record

FHIR BeMedicationDispenseAuthorizingPrescription datatype record.

Fields
  • reference? string - A 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.
  • identifier? Identifier - An 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.
  • extension? Extension[] - May 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 manageable, 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.
  • display? string - Plain text narrative that identifies the resource in addition to the resource reference.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 'type? uri - The 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).

health.fhir.r4.be.medication100: BeMedicationDispenseContext

Closed record

FHIR BeMedicationDispenseContext datatype record.

Fields
  • reference? string - A 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.
  • identifier? BeMedicationDispenseContextIdentifier - An 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.
  • extension? Extension[] - May 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 manageable, 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.
  • display? string - Plain text narrative that identifies the resource in addition to the resource reference.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 'type? uri - The 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).

health.fhir.r4.be.medication100: BeMedicationDispenseContextIdentifier

Closed record

FHIR BeMedicationDispenseContextIdentifier datatype record.

Fields
  • extension? Extension[] - May 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 manageable, 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.
  • period? Period - Time period during which identifier is/was valid for use.
  • system? uri - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
  • assigner? Reference - Organization that issued/manages the identifier.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
  • value? string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.be.medication100: BeMedicationDispenseDosageInstruction

Closed record

FHIR BeMedicationDispenseDosageInstruction datatype record.

Fields
  • maxDosePerLifetime? Quantity - Upper limit on medication per lifetime of the patient.
  • additionalInstruction? CodeableConcept[] - Supplemental 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').
  • extension? Extension[] - May 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 manageable, 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.
  • timing? Timing - When medication should be administered.
  • modifierExtension? Extension[] - May 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 manageable, 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).
  • sequence? integer - Indicates the order in which the dosage instructions should be applied or interpreted.
  • asNeededBoolean? boolean - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
  • maxDosePerAdministration? Quantity - Upper limit on medication per administration.
  • maxDosePerPeriod? Ratio - Upper limit on medication per unit of time.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • text? string - Free text dosage instructions e.g. SIG.
  • asNeededCodeableConcept? CodeableConcept - Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
  • patientInstruction? string - Instructions in terms that are understood by the patient or consumer.

health.fhir.r4.be.medication100: BeMedicationDispenseIdentifierDGUID

Closed record

FHIR BeMedicationDispenseIdentifierDGUID datatype record.

Fields
  • extension? Extension[] - May 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 manageable, 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.
  • period? Period - Time period during which identifier is/was valid for use.
  • system uri(default "https://www.gfd-dpp.be/fhir/reference/dguid") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
  • assigner? Reference - Organization that issued/manages the identifier.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
  • value? string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.

health.fhir.r4.be.medication100: BeMedicationDispensePerformer

Closed record

FHIR BeMedicationDispensePerformer datatype record.

Fields
  • actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
  • extension? Extension[] - May 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 manageable, 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.
  • 'function? CodeableConcept - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.
  • modifierExtension? Extension[] - May 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 manageable, 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).
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4.be.medication100: BeMedicationDispenseSubstitution

Closed record

FHIR BeMedicationDispenseSubstitution datatype record.

Fields
  • reason? CodeableConcept[] - Indicates the reason for the substitution (or lack of substitution) from what was prescribed.
  • extension? Extension[] - May 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 manageable, 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.
  • wasSubstituted boolean - True if the dispenser dispensed a different drug or product from what was prescribed.
  • modifierExtension? Extension[] - May 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 manageable, 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).
  • responsibleParty? Reference[] - The person or organization that has primary responsibility for the substitution.
  • id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 'type? CodeableConcept - A code signifying whether a different drug was dispensed from what was prescribed.

Import

import ballerinax/health.fhir.r4.be.medication100;Copy

Other versions

1.0.0

Metadata

Released date: 42 minutes ago

Version: 1.0.0

Compatibility

Platform: any

Ballerina version: 2201.12.8

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Keywords

Healthcare

FHIR

R4

health_fhir_r4_be_medication100

Contributors

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC