Page Status: updated 2024-10-28
NLLMedicationDispense (MedicationDispense)
Page index
Introduction
The MedicationDispense resource, shown in the profile NLLMedicationDispense, represents a dispense of medication or medical consumable at a pharmacy. The profile NLLMedicationDispense represents the normal scenario, in which the prescription has been registered in the Swedish National Medication List prior to dispensing.
Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources
Overview
NLLMedicationDispense (MedicationDispense) | I | MedicationDispense | |
id | S Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 3..* | Extension |
nllNumberOfPackagesDispensed | S I | 0..1 | Extension(positiveInt) |
nllActorDispatchId | S I | 1..1 | Extension(string) |
nllDispatchId | S I | 0..1 | Extension(string) |
nllBenefitChoiceCode | S I | 1..1 | Extension(code)Binding |
nllDispatchRowNo | S I | 1..1 | Extension(decimal) |
nllDeductedQuantity | S I | 0..1 | Extension(decimal) |
nllCompletePrescriptionChoice | S I | 0..1 | Extension(code)Binding |
nllDispenseCrediting | S I | 0..1 | Extension(Complex) |
id | 0..1 | string | |
extension | I | 2..* | Extension |
creditDate | S I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valueDateTime | dateTime | ||
creditDispatchId | S I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valueString | string | ||
creditDispatchRowNo | S I | 0..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
url | 1..1 | uriFixed Value | |
value[x] | 0..0 | ||
modifierExtension | ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
partOf | 0..* | Reference(Procedure) | |
status | S Σ ?! | 1..1 | codeBinding |
statusReason[x] | 0..1 | ||
statusReasonCodeableConcept | CodeableConcept | ||
statusReasonReference | Reference(DetectedIssue) | ||
category | 0..1 | CodeableConceptBinding | |
medication[x] | S Σ | 1..1 | Binding |
medicationCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
nplid | S Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
nplpackid | S Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
varunr | S Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
subject | Σ | 0..1 | Reference(Patient | Group) |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | |
supportingInformation | 0..* | Reference(Resource) | |
performer | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
function | 0..1 | CodeableConcept | |
actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | |
location | 0..1 | Reference(Location) | |
authorizingPrescription | S | 1..1 | Reference(NLLMedicationRequest) |
type | S | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
quantity | S | 0..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 0..1 | uri |
code | Σ | 0..1 | code |
daysSupply | 0..1 | SimpleQuantity | |
whenPrepared | Σ | 0..1 | dateTime |
whenHandedOver | S | 0..1 | dateTime |
destination | 0..1 | Reference(Location) | |
receiver | 0..* | Reference(Patient | Practitioner) | |
note | S | 0..1 | Annotation |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime |
text | S Σ | 1..1 | markdown |
dosageInstruction | S | 0..* | NLLDosage |
id | 0..1 | string | |
extension | I | 0..* | Extension |
nllObservandumDose | S I | 0..1 | Extension(boolean) |
nllAdministeringInstruction | S I | 0..1 | Extension(string) |
nllMedicalDevice | S I | 0..1 | Extension(CodeableConcept) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
nllSubSequence | S I | 0..1 | Extension(integer) |
nllDosageType | S I | 0..1 | Extension(code) |
nllSiteQualifier | S I | 0..1 | Extension(CodeableConcept) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | S Σ | 1..1 | integer |
text | S Σ | 0..1 | string |
additionalInstruction | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
text | S Σ | 0..1 | string |
patientInstruction | S Σ | 1..1 | string |
timing | S Σ | 0..1 | Timing |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
event | Σ | 0..* | dateTime |
repeat | S Σ I | 0..1 | Element |
id | 0..1 | string | |
extension | I | 0..* | Extension |
nllSubSequenceDuration | S I | 0..1 | Extension(Quantity) |
bounds[x] | S Σ | 0..1 | |
boundsDuration | S Σ | 0..1 | Duration |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | codeBindingFixed Value |
boundsRange | S Σ | 0..1 | Range |
id | 0..1 | string | |
extension | I | 0..* | Extension |
low | S Σ | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | codeBindingFixed Value |
high | S Σ | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | codeBindingFixed Value |
count | S Σ | 0..1 | positiveInt |
countMax | Σ | 0..1 | positiveInt |
duration | S Σ | 0..1 | decimal |
durationMax | Σ | 0..1 | decimal |
durationUnit | S Σ | 0..1 | codeBinding |
frequency | S Σ | 0..1 | positiveInt |
frequencyMax | S Σ | 0..1 | positiveInt |
period | S Σ | 0..1 | decimal |
periodMax | S Σ | 0..1 | decimal |
periodUnit | S Σ | 0..1 | codeBinding |
dayOfWeek | S Σ | 0..* | codeBinding |
timeOfDay | S Σ | 0..* | time |
when | S Σ | 0..* | codeBinding |
offset | Σ | 0..1 | unsignedInt |
code | Σ | 0..1 | CodeableConceptBinding |
asNeeded[x] | S Σ | 0..1 | |
asNeededBoolean | boolean | ||
site | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
route | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
method | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
doseAndRate | S Σ | 0..1 | Element |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | Σ | 0..1 | CodeableConcept |
dose[x] | S Σ | 0..1 | Binding |
doseRange | S Σ | 0..1 | Range |
id | 0..1 | string | |
extension | I | 0..* | Extension |
low | S Σ | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | code |
high | S Σ | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | code |
doseQuantity | S Σ | 0..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
rate[x] | S Σ | 0..1 | Binding |
rateQuantity | SimpleQuantity | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | code |
maxDosePerPeriod | S Σ | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 1..1 | code |
denominator | S Σ | 0..1 | QuantityFixed Value |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimalFixed Value |
comparator | Σ ?! | 0..1 | codeBinding |
unit | Σ | 0..1 | string |
system | S Σ I | 0..1 | uriFixed Value |
code | S Σ | 0..1 | codeFixed Value |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity |
substitution | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
wasSubstituted | S | 1..1 | boolean |
type | 0..1 | CodeableConcept | |
reason | 0..* | CodeableConcept | |
responsibleParty | 0..* | Reference(Practitioner | PractitionerRole) | |
detectedIssue | S | 0..* | Reference(NLLDetectedIssue) |
eventHistory | 0..* | Reference(Provenance) |
MedicationDispense | |
Definition | A medication dispense to a specific patient authorzied by a prescription in electronic format. Medication dispenses authorized by paper based prescriptions must use the profile NLLDispensePaperPrescription. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
MedicationDispense.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. This id is identified by the URI http://electronichealth.se/identifier/nllmedicationdispenseid in documentation and external systems. |
Mappings |
|
MedicationDispense.meta | |
Definition | 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. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
MedicationDispense.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.meta.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
MedicationDispense.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
MedicationDispense.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
MedicationDispense.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Must Support | True |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
MedicationDispense.meta.security.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.meta.security.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.meta.security.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.security.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.security.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.security.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.security.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
MedicationDispense.implicitRules | |
Definition | 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | 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 it's narrative along with other profiles, value sets, etc. |
Invariants |
|
MedicationDispense.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | 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). |
Invariants |
|
MedicationDispense.text | |
Definition | 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have 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. |
Invariants |
|
Mappings |
|
MedicationDispense.contained | |
Definition | 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | 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. |
Mappings |
|
MedicationDispense.extension | |
Definition | 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. |
Cardinality | 3...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllNumberOfPackagesDispensed | |
Definition | The number of packages that were included in the dispense. Shall not be set for dose dispensed dispenses. |
Cardinality | 0...1 |
Type | Extension(positiveInt) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllActorDispatchId | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 1...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | Maximum string length: 12 |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispatchId | |
Definition | Value is treated as an integer, i.e the String can only contain numbers. May be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency . The identifier of the dispatch in which the dispense was made. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllBenefitChoiceCode | |
Definition | Type of benefit for the dispense. |
Cardinality | 1...1 |
Type | Extension(code) |
Binding | benefit-choices (required) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispatchRowNo | |
Definition | Used when communicationg an error or warning for a MedicationDispense within a dispatch. The DispatchRowNo (ExpeditionsRadNummer) uniquely identifies a MediationDispense within a dispatch. |
Cardinality | 1...1 |
Type | Extension(decimal) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDeductedQuantity | |
Definition | The quantity that is deducted form the prescription's remaining quantity. Only used if the deducted quantity should differ from the dispensed quantity. |
Cardinality | 0...1 |
Type | Extension(decimal) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllCompletePrescriptionChoice | |
Definition | Only used for input. When 12% or less of the total quantity of the prescribed medication is left, the prescription will automatically be set to status "Completed". A pharmacist can make a descision to overrule the automatic rules by either choosing to set the prescription status to "Completed" or to keep the status "Active". |
Cardinality | 0...1 |
Type | Extension(code) |
Binding | complete-prescription-choices (required) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting | |
Definition | Crediting details for a dispense |
Cardinality | 0...1 |
Type | Extension(Complex) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension | |
Definition | 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. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate | |
Definition | The date and time when the dispense was credited. |
Cardinality | 1...1 |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | creditDate |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId | |
Definition | The id of the crediting dispatch. |
Cardinality | 1...1 |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | creditDispatchId |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo | |
Definition | NB! New attribute planned in release 21.9. Display only. The row number of the crediting dispatch. Identifier for a dispense within a credited dispatch. The crediting row number is submitted in the attribute 'MedicationDispense.extension:nllDispatchRowNo', but will be displayed in 'creditDispatchRowNo'. |
Cardinality | 0...1 |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | creditDispatchRowNo |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | base64Binary |
Invariants |
|
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting |
Mappings |
|
MedicationDispense.extension:nllDispenseCrediting.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
MedicationDispense.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.identifier | |
Definition | 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. |
Cardinality | 0...* |
Type | Identifier |
Comments | This is a business identifier, not a resource identifier. |
Invariants |
|
Mappings |
|
MedicationDispense.partOf | |
Definition | The procedure that trigger the dispense. |
Cardinality | 0...* |
Type | Reference(Procedure) |
Invariants |
|
Mappings |
|
MedicationDispense.status | |
Definition | A code specifying the state of the set of dispense events. |
Cardinality | 1...1 |
Type | code |
Binding | A coded concept specifying the state of the dispense event. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
MedicationDispense.statusReason[x] | |
Definition | Indicates the reason why a dispense was not performed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code describing why a dispense was not performed. |
Invariants |
|
Mappings |
|
MedicationDispense.category | |
Definition | Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code describing where the dispensed medication is expected to be consumed or administered. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x] | |
Definition | Identifies the medication or reimbursed consumable being dispensed. The codes used are Swedish NplId for medical products, NplPackId for medicine packages and Varunr for reimbursed consumables. For a medicine package, both the NplId and the NplPackId shall be provided. Varunr is not allowed to use when dispensing a medication. For a reimbursed consumable, only Varunr shall be provided. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A coded concept identifying which substance or product can be dispensed. |
Must Support | True |
Summary | True |
Comments | If more information is required, then the use of the medication resource is recommended. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.medication[x].extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid | |
Definition | A unique identifier of a medical product according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket) |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.medication[x].coding:nplid.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://electronichealth.se/fhir/NamingSystem/nplid |
Mappings |
|
MedicationDispense.medication[x].coding:nplid.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Maximum string length: 14 |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplid.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid | |
Definition | A unique identifier of a medical product package according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket). |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://electronichealth.se/fhir/NamingSystem/nplpackid |
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Maximum string length: 14 |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:nplpackid.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr | |
Definition | A unique identifier of a medical consumable according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket) Also a non-unique identifier of a medical product package. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.medication[x].coding:varunr.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://electronichealth.se/fhir/NamingSystem/varunr |
Mappings |
|
MedicationDispense.medication[x].coding:varunr.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Minimum string length: 6 Maximum string length: 6 |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].coding:varunr.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.medication[x].text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
MedicationDispense.subject | |
Definition | A link to a resource representing the person or the group to whom the medication will be given. |
Cardinality | 0...1 |
Type | Reference(Patient | Group) |
Summary | True |
Comments | SubstanceAdministration->subject->Patient. |
Invariants |
|
Mappings |
|
MedicationDispense.context | |
Definition | The encounter or episode of care that establishes the context for this event. |
Cardinality | 0...1 |
Type | Reference(Encounter | EpisodeOfCare) |
Invariants |
|
Mappings |
|
MedicationDispense.supportingInformation | |
Definition | Additional information that supports the medication being dispensed. |
Cardinality | 0...* |
Type | Reference(Resource) |
Invariants |
|
Mappings |
|
MedicationDispense.performer | |
Definition | Indicates who or what performed the event. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
MedicationDispense.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.performer.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.performer.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.performer.function | |
Definition | Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code describing the role an individual played in dispensing a medication. |
Requirements | Allows disambiguation of the types of involvement of different performers. |
Invariants |
|
Mappings |
|
MedicationDispense.performer.actor | |
Definition | The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) |
Invariants |
|
Mappings |
|
MedicationDispense.location | |
Definition | The principal physical location where the dispense was performed. |
Cardinality | 0...1 |
Type | Reference(Location) |
Invariants |
|
Mappings |
|
MedicationDispense.authorizingPrescription | |
Definition | Reference to the MedicationRequest that was dispatched. Note that authorizingprescription must include the version of the medication request. That is done by using the /_history/ suffix. |
Cardinality | 1...1 |
Type | Reference(NLLMedicationRequest) |
Must Support | True |
Comments | Maps to basedOn in Event logical model. |
Invariants |
|
Mappings |
|
MedicationDispense.type | |
Definition | Type is used for specifing if the dispense was a "Standard packing fill" , "Trial fill" (startförpackning) or "Dose dispensed fill" in the Swedish National Medication List. (Trial fill is not used for dose dispensed fills). |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Indicates the type of dispensing event that is performed, e.g. Standard packing fill, Trial fill or Dose dispense refill |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.type.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.type.coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.type.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
MedicationDispense.quantity | |
Definition | The amount of the article that has been dispensed. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Must Support | True |
Comments | When dispensing an article (not for dose dispenses), this will be either set by the pharmacy or calculated based on the number of packages and the package size. <br> If complete packages are dispensed, the quantity is calculated by the Swedish eHealth Agency. In this scenarion only the number of packages should be entered (no quantity).<br> If only a part of a package is dispensed (sv bruten helförpackning), the pharmacy must enter both the quantity and the number of packages that was dispensed. <br> |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.quantity.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.quantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.daysSupply | |
Definition | The amount of medication expressed as a timing amount. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
MedicationDispense.whenPrepared | |
Definition | The time when the dispensed product was packaged and reviewed. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.whenHandedOver | |
Definition | The time the dispensed product was provided to the patient or their representative. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.destination | |
Definition | Identification of the facility/location where the medication was shipped to, as part of the dispense event. |
Cardinality | 0...1 |
Type | Reference(Location) |
Invariants |
|
Mappings |
|
MedicationDispense.receiver | |
Definition | 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. |
Cardinality | 0...* |
Type | Reference(Patient | Practitioner) |
Invariants |
|
Mappings |
|
MedicationDispense.note | |
Definition | The pharmacists note about the dispense. |
Cardinality | 0...1 |
Type | Annotation |
Must Support | True |
Comments | Maximum string length: 1016 |
Invariants |
|
Mappings |
|
MedicationDispense.note.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.note.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.note.author[x] | |
Definition | The individual responsible for making the annotation. |
Cardinality | 0...1 |
Type | Reference(Practitioner | Patient | RelatedPerson | Organization) |
Summary | True |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Invariants |
|
Mappings |
|
MedicationDispense.note.time | |
Definition | Indicates when this particular annotation was made. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.note.text | |
Definition | The text of the annotation in markdown format. |
Cardinality | 1...1 |
Type | markdown |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction | |
Definition | Indicates how the medication is/was taken or should be taken by the patient. |
Cardinality | 0...* |
Type | NLLDosage |
Must Support | True |
Comments | A medication dispense is always based/dispatched on a specific version of a medication request. <br> A dosage instruction must be provided of there is a unique dosage for the medication dispense which differs from the dosage instruction on the medication request version. <br> The dosage instruction on the medication request version is used as the valid dosage if no other dosage instruction is provided on the medication dispense. <br> If a new dosage instruction should be in effect for the current and following medication dispenses, the medication request needs to be updated before the medication dispense is made.<br> For a read-operation on a medication dispense, the dosage instruction must be read from the medication request version if there is no dosage instruction on the specific medication dispense resource. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllObservandumDose | |
Definition | Indicates that the prescriber has made a conscious choice where the dose exceeds what is recommended for the prescribed medication. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Must Support | True |
Alias | extensions, user content |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllAdministeringInstruction | |
Definition | Administration instructions put in terms that are comprehensible to the patient. This shall be generated from the structured administration information attributes. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice | |
Definition | Medical device to use for administration. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Must Support | True |
Alias | extensions, user content |
Requirements | If there is no appropriate coded value, then the code OTH=Other should be used together with the free text element "text” |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLMedicalDevice |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | http://electronichealth.se/fhir/ValueSet/nll-snomed-medical-device (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllMedicalDevice.value[x].text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSubSequence | |
Definition | Indicates the order of subqeuences within a sequence. |
Cardinality | 0...1 |
Type | Extension(integer) |
Must Support | True |
Alias | extensions, user content |
Requirements | Only used in dosage type "tillfällesdosering”, using "timeOfDay" or "when" |
Comments | The purpose of a subsequence is to provide a repeating mechanism within a sequence. Subsequences enable communication of irregular dosage schedules that should be repeated within a sequence. <br> NB! There are a number of elements that must contain the same values on each sequence and subsequence. For example the dose unit and dose rate unit, the site, route and method and the asNeeded-attribute. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllDosageType | |
Definition | Calculated by the Swedish eHealth Agency. The dosage type that matches the provided set of dosage data. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier | |
Definition | Qualified adminsitration site is used when more exact information about the site is needed. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Must Support | True |
Alias | extensions, user content |
Requirements | To be used only when combinated with MedicationRequest.dosageInstruction.site.coding If there is no appropriate coded value, then the code OTH=Other must be used in combination the free text attribute "text". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLSiteQualifier |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | http://electronichealth.se/fhir/ValueSet/nll-snomed-qualifier (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.extension:nllSiteQualifier.value[x].text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted . |
Cardinality | 1...1 |
Type | integer |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | NB! There are a number of elements that must contain the same values on each sequence and subsequence. For example the dose unit and dose rate unit, the site, route and method and the asNeeded-attribute. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.text | |
Definition | Free text dosage |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List there will be either a free text dosage or coded dosage instructions, never both. |
Comments | Maximum string length: 512 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.additionalInstruction | |
Definition | 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"). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List Additional instruction is written in free text. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.additionalInstruction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.additionalInstruction.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.additionalInstruction.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.additionalInstruction.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List Additional instruction is written in free text. |
Comments | Maximum string length: 512 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.patientInstruction | |
Definition | Dosage instructions in terms that are understood by the patient. This shall be generated from the structured dosage information attributes. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing | |
Definition | When medication should be administered. |
Cardinality | 0...1 |
Type | Timing |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.event | |
Definition | Identifies specific times when the event occurs. |
Cardinality | 0...* |
Type | dateTime |
Summary | True |
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Cardinality | 0...1 |
Type | Element |
Must Support | True |
Summary | True |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.extension:nllSubSequenceDuration | |
Definition | The duration of the subsequence. This can only be used if there is a subsequence within the sequence. The length of a subsequence is always in the form of a quantity (never a range) and it can only be expressed in days, not hours, weeks or months. |
Cardinality | 0...1 |
Type | Extension(Quantity) |
Must Support | True |
Alias | extensions, user content |
Requirements | Used for the dosage type "tillfällesdosering". |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x] | |
Definition | Either 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. |
Cardinality | 0...1 |
Type | Duration |
Must Support | True |
Summary | True |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration | |
Definition | A duration for the length of the timing schedule. |
Cardinality | 0...1 |
Type | Duration |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.comparator | |
Definition | How 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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Fixed Value | d |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange | |
Definition | A range of possible length. |
Cardinality | 0...1 |
Type | Range |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low | |
Definition | The low limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the low boundary is not known. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.low.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Fixed Value | d |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high | |
Definition | The high limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the high element is missing, the high boundary is not known. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.bounds[x]:boundsRange.high.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Fixed Value | d |
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.count | |
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List count is used for describing single dosages that occur one (1) time. The only value allowed is count=1 |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.countMax | |
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.duration | |
Definition | Duration of the administration of the medication |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | Duration is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9]) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.durationMax | |
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
Cardinality | 0...1 |
Type | decimal |
Summary | True |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Cardinality | 0...1 |
Type | code |
Binding | A unit of time (units from UCUM). |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.frequency | |
Definition | The 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. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.period | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Cardinality | 0...1 |
Type | code |
Binding | A unit of time (units from UCUM). |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek | |
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
Cardinality | 0...* |
Type | code |
Binding | DaysOfWeek (required) |
Must Support | True |
Summary | True |
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.timeOfDay | |
Definition | Specified time of day for action to take place. Must currently be expressed on the hour, i.e. 11:00 or 15:00. This may be changed after the transition period (övergångs-perioden) so that half hours, i.e. 11:30, are allowed, as well. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. |
Cardinality | 0...* |
Type | time |
Must Support | True |
Summary | True |
Requirements | Used for the dosage type "tillfällesdosering". The elements “when, frequency and period” cannot be used with the element “timeOfDay” simultaneously. |
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.when | |
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
Cardinality | 0...* |
Type | code |
Binding | Real world event relating to the schedule. |
Must Support | True |
Summary | True |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.repeat.offset | |
Definition | The 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. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.timing.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Code for a known / defined timing pattern. |
Summary | True |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.asNeeded[x] | |
Definition | Indicates that the medication only should be taken when needed. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Summary | True |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site | |
Definition | Site of administration. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the site location the medicine enters into or onto the body. |
Must Support | True |
Summary | True |
Requirements | A coded specification of the anatomic site where the medication first enters the body. If there is no appropriate coded value, then the code OTH=Other should be used together with the free text attribute "text". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.site.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration site, as stipulated by NLL (terminology server). |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.site.text | |
Definition | A human language representation of the administration site. Used when no specific code can describe the site and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route | |
Definition | How the medication should enter the body. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Must Support | True |
Summary | True |
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. If there is no appropriate coded value, then the code OTH=Other must be used together with the free text attribute "text". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.route.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration route, as stipulated by NLL |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.route.text | |
Definition | A human language representation of the administration route. Used when no specific code can describe the route and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method | |
Definition | Method used for administering the medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the technique by which the medicine is administered. |
Must Support | True |
Summary | True |
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. If there is no appropriate coded value, then the code OTH=Other should be used together with the free text attribute "text". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.method.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration method, as stipulated by NLL (terminology server). |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.method.text | |
Definition | A human language representation of the administration method. Used when no specific code can describe the method and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate | |
Definition | The amount of medication administered. |
Cardinality | 0...1 |
Type | Element |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.type | |
Definition | The kind of dose or rate specified, for example, ordered or calculated. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The kind of dose or rate specified. |
Summary | True |
Requirements | If the type is not populated, assume to be "ordered". |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range |
Binding | nll-ucum-unit (required) |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | _ |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low | |
Definition | The low limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the low boundary is not known. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.value | |
Definition | Dose range low value |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | Dose range low value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9]) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.low.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high | |
Definition | The high limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the high element is missing, the high boundary is not known. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.value | |
Definition | Dose range high value |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | Dose range high value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9]) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange.high.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.value | |
Definition | Dose quantity value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | Dose quantity value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9]) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x] | |
Definition | Amount of medication per unit of time. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Binding | nll-ucum-rate-unit (required) |
Must Support | True |
Summary | True |
Requirements | _ |
Comments | _ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].value | |
Definition | Rate value |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | Rate value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9]) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.doseAndRate.rate[x].code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod | |
Definition | Upper limit on medication per day. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | nll-ucum-unit (required) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.value | |
Definition | Max dose therapeutic substance value |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | NB! If maxDosePerPeriod contains a value, it must be > 0 (greater than zero); i.e 0 and negative numbers are not allowed. Max dose therapeutic substance value is handled with a maximum precision of 4 decimals. Corresponing regex: ^(?!0*[.,]0*$|[.,]0*$|0*$)\d+[,.]?\d{0,4}$ |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.comparator | |
Definition | How 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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Must Support | True |
Summary | True |
Invariants |
|
Fixed Value | { "value": 1, "system": "http://unitsofmeasure.org", "code": "d" } |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 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). |
Invariants |
|
Fixed Value | 1 |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.comparator | |
Definition | How 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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Fixed Value | http://unitsofmeasure.org |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Fixed Value | d |
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.dosageInstruction.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
Invariants |
|
Mappings |
|
MedicationDispense.substitution | |
Definition | 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. If nothing is specified, substitution was not done. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationDispense.substitution.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.wasSubstituted | |
Definition | True if the dispenser dispensed a different drug or product from what was prescribed. |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.type | |
Definition | A code signifying whether a different drug was dispensed from what was prescribed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.reason | |
Definition | Indicates the reason for the substitution (or lack of substitution) from what was prescribed. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. |
Invariants |
|
Mappings |
|
MedicationDispense.substitution.responsibleParty | |
Definition | The person or organization that has primary responsibility for the substitution. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole) |
Invariants |
|
Mappings |
|
MedicationDispense.detectedIssue | |
Definition | Accepted warnings can be provided when creating a MedicationDispense. Automatic Format and Constitution Control (AFF) accepted by the pharmacist. NB! The DetectedIssues are never saved by the Swedish eHealth Agency. |
Cardinality | 0...* |
Type | Reference(NLLDetectedIssue) |
Must Support | True |
Alias | Contraindication, Drug Utilization Review (DUR), Alert |
Comments | This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue. |
Invariants |
|
Mappings |
|
MedicationDispense.eventHistory | |
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | 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.). |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="f06c6e96-4495-4afa-b688-02bef19f2d6d" /> <meta> <versionId value="1" /> <lastUpdated value="2025-01-14T09:38:18.4148619+00:00" /> </meta> <url value="http://electronichealth.se/fhir/StructureDefinition/NLLMedicationDispense" /> <version value="1.2.1" /> <name value="NLLMedicationDispense" /> <status value="active" /> <date value="2025-01-14" /> <publisher value="Swedish eHealth Agency" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="EHM" /> <name value="E-hälsomyndigheten concept" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="MedicationDispense" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MedicationDispense" /> <derivation value="constraint" /> <differential> <element id="MedicationDispense"> <path value="MedicationDispense" /> <short value="A medication dispense to a specific patient authorzied by a prescription" /> <definition value="A medication dispense to a specific patient authorzied by a prescription in electronic format. Medication dispenses authorized by paper based prescriptions must use the profile NLLDispensePaperPrescription." /> </element> <element id="MedicationDispense.id"> <path value="MedicationDispense.id" /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation.\nThis id is identified by the URI http://electronichealth.se/identifier/nllmedicationdispenseid in documentation and external systems." /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Logiskt id för uttag" /> </mapping> </element> <element id="MedicationDispense.meta"> <path value="MedicationDispense.meta" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.meta.versionId"> <path value="MedicationDispense.meta.versionId" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Uttagsversion" /> </mapping> </element> <element id="MedicationDispense.meta.security"> <path value="MedicationDispense.meta.security" /> <mustSupport value="true" /> <binding> <strength value="extensible" /> <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/security-labels" /> </binding> </element> <element id="MedicationDispense.meta.security.system"> <path value="MedicationDispense.meta.security.system" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.meta.security.version"> <path value="MedicationDispense.meta.security.version" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.meta.security.code"> <path value="MedicationDispense.meta.security.code" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.extension"> <path value="MedicationDispense.extension" /> <min value="3" /> </element> <element id="MedicationDispense.extension:nllNumberOfPackagesDispensed"> <path value="MedicationDispense.extension" /> <sliceName value="nllNumberOfPackagesDispensed" /> <short value="Number of packages dispensed" /> <definition value="The number of packages that were included in the dispense. Shall not be set for dose dispensed dispenses." /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLNumberOfPackagesDispensed" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Antal expedierade förpackningar" /> </mapping> </element> <element id="MedicationDispense.extension:nllActorDispatchId"> <path value="MedicationDispense.extension" /> <sliceName value="nllActorDispatchId" /> <short value="The identifier of the actor's dispatch in which the dispense was made" /> <comment value="Maximum string length: 12" /> <min value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Aktörens expeditions-id" /> </mapping> </element> <element id="MedicationDispense.extension:nllDispatchId"> <path value="MedicationDispense.extension" /> <sliceName value="nllDispatchId" /> <short value="The identifier of the dispatch in which the dispense was made" /> <definition value="Value is treated as an integer, i.e the String can only contain numbers.\nMay be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency .\nThe identifier of the dispatch in which the dispense was made." /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLDispatchId" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Expeditions-id" /> </mapping> </element> <element id="MedicationDispense.extension:nllBenefitChoiceCode"> <path value="MedicationDispense.extension" /> <sliceName value="nllBenefitChoiceCode" /> <short value="Benefit choice" /> <definition value="Type of benefit for the dispense." /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLBenefitChoiceCode" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/benefit-choices" /> </binding> <mapping> <identity value="EHM" /> <map value="Förmånsval" /> </mapping> </element> <element id="MedicationDispense.extension:nllDispatchRowNo"> <path value="MedicationDispense.extension" /> <sliceName value="nllDispatchRowNo" /> <short value="Identier for MedicationDispense within dispatch" /> <definition value="Used when communicationg an error or warning for a MedicationDispense within a dispatch. The DispatchRowNo (ExpeditionsRadNummer) uniquely identifies a MediationDispense within a dispatch." /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLDispatchRowNo" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Aktörens expeditionsradnummer" /> </mapping> </element> <element id="MedicationDispense.extension:nllDeductedQuantity"> <path value="MedicationDispense.extension" /> <sliceName value="nllDeductedQuantity" /> <short value="Deducted quantity" /> <definition value="The quantity that is deducted form the prescription's remaining quantity.\nOnly used if the deducted quantity should differ from the dispensed quantity." /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLDeductedQuantity" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Avräknad mängd" /> </mapping> </element> <element id="MedicationDispense.extension:nllCompletePrescriptionChoice"> <path value="MedicationDispense.extension" /> <sliceName value="nllCompletePrescriptionChoice" /> <short value="Prescription completion choice" /> <definition value="Only used for input.\nWhen 12% or less of the total quantity of the prescribed medication is left, the prescription will automatically be set to status "Completed". \nA pharmacist can make a descision to overrule the automatic rules by either choosing to set the prescription status to "Completed" or to keep the status "Active"." /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLCompletePrescriptionChoice" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/complete-prescription-choices" /> </binding> <mapping> <identity value="EHM" /> <map value="Beslut slutexpediering" /> </mapping> </element> <element id="MedicationDispense.extension:nllDispenseCrediting"> <path value="MedicationDispense.extension" /> <sliceName value="nllDispenseCrediting" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting" /> </type> <mustSupport value="true" /> </element> <element id="MedicationDispense.extension:nllDispenseCrediting.extension:creditDate"> <path value="MedicationDispense.extension.extension" /> <sliceName value="creditDate" /> <short value="Credit date and time" /> <definition value="The date and time when the dispense was credited." /> <mustSupport value="true" /> </element> <element id="MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId"> <path value="MedicationDispense.extension.extension" /> <sliceName value="creditDispatchId" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo"> <path value="MedicationDispense.extension.extension" /> <sliceName value="creditDispatchRowNo" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.status"> <path value="MedicationDispense.status" /> <short value="cancelled | completed" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/ValueSet/medication-dispense-status" /> </binding> <mapping> <identity value="EHM" /> <map value="Uttagsstatus" /> </mapping> </element> <element id="MedicationDispense.medication[x]"> <path value="MedicationDispense.medication[x]" /> <short value="Dispensed medication or reimbursed consumable" /> <definition value="Identifies the medication or reimbursed consumable being dispensed. \nThe codes used are Swedish NplId for medical products, NplPackId for medicine packages and Varunr for reimbursed consumables. \nFor a medicine package, both the NplId and the NplPackId shall be provided. Varunr is not allowed to use when dispensing a medication.\nFor a reimbursed consumable, only Varunr shall be provided." /> <comment value="If more information is required, then the use of the medication resource is recommended." /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> </binding> <mapping> <identity value="EHM" /> <map value="Expedierad artikel" /> </mapping> </element> <element id="MedicationDispense.medication[x].coding"> <path value="MedicationDispense.medication[x].coding" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:nplid"> <path value="MedicationDispense.medication[x].coding" /> <sliceName value="nplid" /> <short value="NPL-id" /> <definition value="A unique identifier of a medical product according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)" /> <max value="1" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="NPL-id" /> </mapping> </element> <element id="MedicationDispense.medication[x].coding:nplid.system"> <path value="MedicationDispense.medication[x].coding.system" /> <min value="1" /> <fixedUri value="http://electronichealth.se/fhir/NamingSystem/nplid" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:nplid.code"> <path value="MedicationDispense.medication[x].coding.code" /> <comment value="Maximum string length: 14" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:nplpackid"> <path value="MedicationDispense.medication[x].coding" /> <sliceName value="nplpackid" /> <short value="NPL-pack-id" /> <definition value="A unique identifier of a medical product package according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)." /> <max value="1" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="NPL-pack-id" /> </mapping> </element> <element id="MedicationDispense.medication[x].coding:nplpackid.system"> <path value="MedicationDispense.medication[x].coding.system" /> <min value="1" /> <fixedUri value="http://electronichealth.se/fhir/NamingSystem/nplpackid" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:nplpackid.code"> <path value="MedicationDispense.medication[x].coding.code" /> <comment value="Maximum string length: 14" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:varunr"> <path value="MedicationDispense.medication[x].coding" /> <sliceName value="varunr" /> <short value="Varunummer" /> <definition value="A unique identifier of a medical consumable according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)\nAlso a non-unique identifier of a medical product package." /> <max value="1" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Varunummer" /> </mapping> </element> <element id="MedicationDispense.medication[x].coding:varunr.system"> <path value="MedicationDispense.medication[x].coding.system" /> <min value="1" /> <fixedUri value="http://electronichealth.se/fhir/NamingSystem/varunr" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.medication[x].coding:varunr.code"> <path value="MedicationDispense.medication[x].coding.code" /> <comment value="Minimum string length: 6\nMaximum string length: 6" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.authorizingPrescription"> <path value="MedicationDispense.authorizingPrescription" /> <short value="MedicationRequest that authorizes the dispense" /> <definition value="Reference to the MedicationRequest that was dispatched. Note that authorizingprescription must include the version of the medication request. That is done by using the /_history/ suffix." /> <min value="1" /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://electronichealth.se/fhir/StructureDefinition/NLLMedicationRequest" /> <aggregation value="referenced" /> <versioning value="specific" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Förskrivningsversion" /> </mapping> </element> <element id="MedicationDispense.type"> <path value="MedicationDispense.type" /> <short value="Type of dispense" /> <definition value="Type is used for specifing if the dispense was a "Standard packing fill" , "Trial fill" (startförpackning) or "Dose dispensed fill" in the Swedish National Medication List. (Trial fill is not used for dose dispensed fills)." /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <description value="Indicates the type of dispensing event that is performed, e.g. Standard packing fill, Trial fill or Dose dispense refill" /> <valueSet value="http://electronichealth.se/fhir/ValueSet/dispense-types" /> </binding> <mapping> <identity value="EHM" /> <map value="Uttagstyp" /> </mapping> </element> <element id="MedicationDispense.type.coding"> <path value="MedicationDispense.type.coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.type.coding.system"> <path value="MedicationDispense.type.coding.system" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.type.coding.version"> <path value="MedicationDispense.type.coding.version" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.type.coding.code"> <path value="MedicationDispense.type.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.quantity"> <path value="MedicationDispense.quantity" /> <definition value="The amount of the article that has been dispensed." /> <comment value="When dispensing an article (not for dose dispenses), this will be either set by the pharmacy or calculated based on the number of packages and the package size. <br>\nIf complete packages are dispensed, the quantity is calculated by the Swedish eHealth Agency. In this scenarion only the number of packages should be entered (no quantity).<br>\nIf only a part of a package is dispensed (sv bruten helförpackning), the pharmacy must enter both the quantity and the number of packages that was dispensed. <br>" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Expedierad mängd" /> </mapping> </element> <element id="MedicationDispense.quantity.value"> <path value="MedicationDispense.quantity.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.whenHandedOver"> <path value="MedicationDispense.whenHandedOver" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Expeditionstidpunkt" /> </mapping> </element> <element id="MedicationDispense.note"> <path value="MedicationDispense.note" /> <short value="Pharmacists note" /> <definition value="The pharmacists note about the dispense." /> <comment value="Maximum string length: 1016" /> <max value="1" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Uttagsnotering" /> </mapping> </element> <element id="MedicationDispense.note.text"> <path value="MedicationDispense.note.text" /> <mustSupport value="true" /> </element> <element id="MedicationDispense.dosageInstruction"> <path value="MedicationDispense.dosageInstruction" /> <comment value="A medication dispense is always based/dispatched on a specific version of a medication request. <br>\nA dosage instruction must be provided of there is a unique dosage for the medication dispense which differs from the dosage instruction on the medication request version. <br>\nThe dosage instruction on the medication request version is used as the valid dosage if no other dosage instruction is provided on the medication dispense. <br>\nIf a new dosage instruction should be in effect for the current and following medication dispenses, the medication request needs to be updated before the medication dispense is made.<br>\nFor a read-operation on a medication dispense, the dosage instruction must be read from the medication request version if there is no dosage instruction on the specific medication dispense resource." /> <type> <code value="Dosage" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLDosage" /> </type> <mustSupport value="true" /> </element> <element id="MedicationDispense.dosageInstruction.sequence"> <path value="MedicationDispense.dosageInstruction.sequence" /> <definition value="Indicates the order in which the dosage instructions should be applied or interpreted ." /> </element> <element id="MedicationDispense.substitution"> <path value="MedicationDispense.substitution" /> <definition value="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. If nothing is specified, substitution was not done." /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Generikautbyte utfört" /> </mapping> </element> <element id="MedicationDispense.substitution.wasSubstituted"> <path value="MedicationDispense.substitution.wasSubstituted" /> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Generikautbyte utfört" /> </mapping> </element> <element id="MedicationDispense.detectedIssue"> <path value="MedicationDispense.detectedIssue" /> <short value="Automatic Format and Constitution Control warning (AFF varning)" /> <definition value="Accepted warnings can be provided when creating a MedicationDispense.\nAutomatic Format and Constitution Control (AFF) accepted by the pharmacist.\nNB! The DetectedIssues are never saved by the Swedish eHealth Agency." /> <type> <code value="Reference" /> <targetProfile value="http://electronichealth.se/fhir/StructureDefinition/NLLDetectedIssue" /> <aggregation value="contained" /> </type> <mustSupport value="true" /> <mapping> <identity value="EHM" /> <map value="Accepterade varningar" /> </mapping> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "f06c6e96-4495-4afa-b688-02bef19f2d6d", "meta": { "versionId": "1", "lastUpdated": "01/14/2025 09:38:18" }, "url": "http://electronichealth.se/fhir/StructureDefinition/NLLMedicationDispense", "version": "1.2.1", "name": "NLLMedicationDispense", "status": "active", "date": "2025-01-14", "publisher": "Swedish eHealth Agency", "fhirVersion": "4.0.1", "mapping": [ { "identity": "EHM", "name": "E-hälsomyndigheten concept" } ], "kind": "resource", "abstract": false, "type": "MedicationDispense", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "derivation": "constraint", "differential": { "element": [ { "id": "MedicationDispense", "path": "MedicationDispense", "short": "A medication dispense to a specific patient authorzied by a prescription", "definition": "A medication dispense to a specific patient authorzied by a prescription in electronic format. Medication dispenses authorized by paper based prescriptions must use the profile NLLDispensePaperPrescription." }, { "id": "MedicationDispense.id", "path": "MedicationDispense.id", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.\nThis id is identified by the URI http://electronichealth.se/identifier/nllmedicationdispenseid in documentation and external systems.", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Logiskt id för uttag" } ] }, { "id": "MedicationDispense.meta", "path": "MedicationDispense.meta", "mustSupport": true }, { "id": "MedicationDispense.meta.versionId", "path": "MedicationDispense.meta.versionId", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Uttagsversion" } ] }, { "id": "MedicationDispense.meta.security", "path": "MedicationDispense.meta.security", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels" } }, { "id": "MedicationDispense.meta.security.system", "path": "MedicationDispense.meta.security.system", "mustSupport": true }, { "id": "MedicationDispense.meta.security.version", "path": "MedicationDispense.meta.security.version", "mustSupport": true }, { "id": "MedicationDispense.meta.security.code", "path": "MedicationDispense.meta.security.code", "mustSupport": true }, { "id": "MedicationDispense.extension", "path": "MedicationDispense.extension", "min": 3 }, { "id": "MedicationDispense.extension:nllNumberOfPackagesDispensed", "path": "MedicationDispense.extension", "sliceName": "nllNumberOfPackagesDispensed", "short": "Number of packages dispensed", "definition": "The number of packages that were included in the dispense. Shall not be set for dose dispensed dispenses.", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLNumberOfPackagesDispensed" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Antal expedierade förpackningar" } ] }, { "id": "MedicationDispense.extension:nllActorDispatchId", "path": "MedicationDispense.extension", "sliceName": "nllActorDispatchId", "short": "The identifier of the actor's dispatch in which the dispense was made", "comment": "Maximum string length: 12", "min": 1, "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Aktörens expeditions-id" } ] }, { "id": "MedicationDispense.extension:nllDispatchId", "path": "MedicationDispense.extension", "sliceName": "nllDispatchId", "short": "The identifier of the dispatch in which the dispense was made", "definition": "Value is treated as an integer, i.e the String can only contain numbers.\nMay be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency .\nThe identifier of the dispatch in which the dispense was made.", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchId" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Expeditions-id" } ] }, { "id": "MedicationDispense.extension:nllBenefitChoiceCode", "path": "MedicationDispense.extension", "sliceName": "nllBenefitChoiceCode", "short": "Benefit choice", "definition": "Type of benefit for the dispense.", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLBenefitChoiceCode" ] } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/benefit-choices" }, "mapping": [ { "identity": "EHM", "map": "Förmånsval" } ] }, { "id": "MedicationDispense.extension:nllDispatchRowNo", "path": "MedicationDispense.extension", "sliceName": "nllDispatchRowNo", "short": "Identier for MedicationDispense within dispatch", "definition": "Used when communicationg an error or warning for a MedicationDispense within a dispatch. The DispatchRowNo (ExpeditionsRadNummer) uniquely identifies a MediationDispense within a dispatch.", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchRowNo" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Aktörens expeditionsradnummer" } ] }, { "id": "MedicationDispense.extension:nllDeductedQuantity", "path": "MedicationDispense.extension", "sliceName": "nllDeductedQuantity", "short": "Deducted quantity", "definition": "The quantity that is deducted form the prescription's remaining quantity.\nOnly used if the deducted quantity should differ from the dispensed quantity.", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDeductedQuantity" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Avräknad mängd" } ] }, { "id": "MedicationDispense.extension:nllCompletePrescriptionChoice", "path": "MedicationDispense.extension", "sliceName": "nllCompletePrescriptionChoice", "short": "Prescription completion choice", "definition": "Only used for input.\nWhen 12% or less of the total quantity of the prescribed medication is left, the prescription will automatically be set to status \"Completed\". \nA pharmacist can make a descision to overrule the automatic rules by either choosing to set the prescription status to \"Completed\" or to keep the status \"Active\".", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLCompletePrescriptionChoice" ] } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/complete-prescription-choices" }, "mapping": [ { "identity": "EHM", "map": "Beslut slutexpediering" } ] }, { "id": "MedicationDispense.extension:nllDispenseCrediting", "path": "MedicationDispense.extension", "sliceName": "nllDispenseCrediting", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting" ] } ], "mustSupport": true }, { "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDate", "path": "MedicationDispense.extension.extension", "sliceName": "creditDate", "short": "Credit date and time", "definition": "The date and time when the dispense was credited.", "mustSupport": true }, { "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId", "path": "MedicationDispense.extension.extension", "sliceName": "creditDispatchId", "mustSupport": true }, { "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo", "path": "MedicationDispense.extension.extension", "sliceName": "creditDispatchRowNo", "mustSupport": true }, { "id": "MedicationDispense.status", "path": "MedicationDispense.status", "short": "cancelled | completed", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/ValueSet/medication-dispense-status" }, "mapping": [ { "identity": "EHM", "map": "Uttagsstatus" } ] }, { "id": "MedicationDispense.medication[x]", "path": "MedicationDispense.medication[x]", "short": "Dispensed medication or reimbursed consumable", "definition": "Identifies the medication or reimbursed consumable being dispensed. \nThe codes used are Swedish NplId for medical products, NplPackId for medicine packages and Varunr for reimbursed consumables. \nFor a medicine package, both the NplId and the NplPackId shall be provided. Varunr is not allowed to use when dispensing a medication.\nFor a reimbursed consumable, only Varunr shall be provided.", "comment": "If more information is required, then the use of the medication resource is recommended.", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "binding": { "strength": "required" }, "mapping": [ { "identity": "EHM", "map": "Expedierad artikel" } ] }, { "id": "MedicationDispense.medication[x].coding", "path": "MedicationDispense.medication[x].coding", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:nplid", "path": "MedicationDispense.medication[x].coding", "sliceName": "nplid", "short": "NPL-id", "definition": "A unique identifier of a medical product according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)", "max": "1", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "NPL-id" } ] }, { "id": "MedicationDispense.medication[x].coding:nplid.system", "path": "MedicationDispense.medication[x].coding.system", "min": 1, "fixedUri": "http://electronichealth.se/fhir/NamingSystem/nplid", "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:nplid.code", "path": "MedicationDispense.medication[x].coding.code", "comment": "Maximum string length: 14", "min": 1, "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:nplpackid", "path": "MedicationDispense.medication[x].coding", "sliceName": "nplpackid", "short": "NPL-pack-id", "definition": "A unique identifier of a medical product package according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket).", "max": "1", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "NPL-pack-id" } ] }, { "id": "MedicationDispense.medication[x].coding:nplpackid.system", "path": "MedicationDispense.medication[x].coding.system", "min": 1, "fixedUri": "http://electronichealth.se/fhir/NamingSystem/nplpackid", "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:nplpackid.code", "path": "MedicationDispense.medication[x].coding.code", "comment": "Maximum string length: 14", "min": 1, "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:varunr", "path": "MedicationDispense.medication[x].coding", "sliceName": "varunr", "short": "Varunummer", "definition": "A unique identifier of a medical consumable according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)\nAlso a non-unique identifier of a medical product package.", "max": "1", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Varunummer" } ] }, { "id": "MedicationDispense.medication[x].coding:varunr.system", "path": "MedicationDispense.medication[x].coding.system", "min": 1, "fixedUri": "http://electronichealth.se/fhir/NamingSystem/varunr", "mustSupport": true }, { "id": "MedicationDispense.medication[x].coding:varunr.code", "path": "MedicationDispense.medication[x].coding.code", "comment": "Minimum string length: 6\nMaximum string length: 6", "min": 1, "mustSupport": true }, { "id": "MedicationDispense.authorizingPrescription", "path": "MedicationDispense.authorizingPrescription", "short": "MedicationRequest that authorizes the dispense", "definition": "Reference to the MedicationRequest that was dispatched. Note that authorizingprescription must include the version of the medication request. That is done by using the /_history/ suffix.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLMedicationRequest" ], "aggregation": [ "referenced" ], "versioning": "specific" } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Förskrivningsversion" } ] }, { "id": "MedicationDispense.type", "path": "MedicationDispense.type", "short": "Type of dispense", "definition": "Type is used for specifing if the dispense was a \"Standard packing fill\" , \"Trial fill\" (startförpackning) or \"Dose dispensed fill\" in the Swedish National Medication List. (Trial fill is not used for dose dispensed fills).", "min": 1, "mustSupport": true, "binding": { "strength": "required", "description": "Indicates the type of dispensing event that is performed, e.g. Standard packing fill, Trial fill or Dose dispense refill", "valueSet": "http://electronichealth.se/fhir/ValueSet/dispense-types" }, "mapping": [ { "identity": "EHM", "map": "Uttagstyp" } ] }, { "id": "MedicationDispense.type.coding", "path": "MedicationDispense.type.coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "MedicationDispense.type.coding.system", "path": "MedicationDispense.type.coding.system", "mustSupport": true }, { "id": "MedicationDispense.type.coding.version", "path": "MedicationDispense.type.coding.version", "mustSupport": true }, { "id": "MedicationDispense.type.coding.code", "path": "MedicationDispense.type.coding.code", "min": 1, "mustSupport": true }, { "id": "MedicationDispense.quantity", "path": "MedicationDispense.quantity", "definition": "The amount of the article that has been dispensed.", "comment": "When dispensing an article (not for dose dispenses), this will be either set by the pharmacy or calculated based on the number of packages and the package size. <br>\nIf complete packages are dispensed, the quantity is calculated by the Swedish eHealth Agency. In this scenarion only the number of packages should be entered (no quantity).<br>\nIf only a part of a package is dispensed (sv bruten helförpackning), the pharmacy must enter both the quantity and the number of packages that was dispensed. <br>", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Expedierad mängd" } ] }, { "id": "MedicationDispense.quantity.value", "path": "MedicationDispense.quantity.value", "min": 1, "mustSupport": true }, { "id": "MedicationDispense.whenHandedOver", "path": "MedicationDispense.whenHandedOver", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Expeditionstidpunkt" } ] }, { "id": "MedicationDispense.note", "path": "MedicationDispense.note", "short": "Pharmacists note", "definition": "The pharmacists note about the dispense.", "comment": "Maximum string length: 1016", "max": "1", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Uttagsnotering" } ] }, { "id": "MedicationDispense.note.text", "path": "MedicationDispense.note.text", "mustSupport": true }, { "id": "MedicationDispense.dosageInstruction", "path": "MedicationDispense.dosageInstruction", "comment": "A medication dispense is always based/dispatched on a specific version of a medication request. <br>\nA dosage instruction must be provided of there is a unique dosage for the medication dispense which differs from the dosage instruction on the medication request version. <br>\nThe dosage instruction on the medication request version is used as the valid dosage if no other dosage instruction is provided on the medication dispense. <br>\nIf a new dosage instruction should be in effect for the current and following medication dispenses, the medication request needs to be updated before the medication dispense is made.<br>\nFor a read-operation on a medication dispense, the dosage instruction must be read from the medication request version if there is no dosage instruction on the specific medication dispense resource.", "type": [ { "code": "Dosage", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDosage" ] } ], "mustSupport": true }, { "id": "MedicationDispense.dosageInstruction.sequence", "path": "MedicationDispense.dosageInstruction.sequence", "definition": "Indicates the order in which the dosage instructions should be applied or interpreted ." }, { "id": "MedicationDispense.substitution", "path": "MedicationDispense.substitution", "definition": "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. If nothing is specified, substitution was not done.", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Generikautbyte utfört" } ] }, { "id": "MedicationDispense.substitution.wasSubstituted", "path": "MedicationDispense.substitution.wasSubstituted", "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Generikautbyte utfört" } ] }, { "id": "MedicationDispense.detectedIssue", "path": "MedicationDispense.detectedIssue", "short": "Automatic Format and Constitution Control warning (AFF varning)", "definition": "Accepted warnings can be provided when creating a MedicationDispense.\nAutomatic Format and Constitution Control (AFF) accepted by the pharmacist.\nNB! The DetectedIssues are never saved by the Swedish eHealth Agency.", "type": [ { "code": "Reference", "targetProfile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLDetectedIssue" ], "aggregation": [ "contained" ] } ], "mustSupport": true, "mapping": [ { "identity": "EHM", "map": "Accepterade varningar" } ] } ] } }
MedicationDispense | .. | |
MedicationDispense.id | .. | |
MedicationDispense.meta | .. | |
MedicationDispense.meta.versionId | .. | |
MedicationDispense.meta.security | .. | |
MedicationDispense.meta.security.system | .. | |
MedicationDispense.meta.security.version | .. | |
MedicationDispense.meta.security.code | .. | |
MedicationDispense.extension | 3.. | |
MedicationDispense.extension | Extension | ..1 |
MedicationDispense.extension | Extension | 1.. |
MedicationDispense.extension | Extension | .. |
MedicationDispense.extension | Extension | 1..1 |
MedicationDispense.extension | Extension | 1..1 |
MedicationDispense.extension | Extension | .. |
MedicationDispense.extension | Extension | ..1 |
MedicationDispense.extension | Extension | .. |
MedicationDispense.extension.extension | .. | |
MedicationDispense.extension.extension | .. | |
MedicationDispense.extension.extension | .. | |
MedicationDispense.status | .. | |
MedicationDispense.medication[x] | CodeableConcept | .. |
MedicationDispense.medication[x].coding | 1.. | |
MedicationDispense.medication[x].coding | ..1 | |
MedicationDispense.medication[x].coding.system | 1.. | |
MedicationDispense.medication[x].coding.code | 1.. | |
MedicationDispense.medication[x].coding | ..1 | |
MedicationDispense.medication[x].coding.system | 1.. | |
MedicationDispense.medication[x].coding.code | 1.. | |
MedicationDispense.medication[x].coding | ..1 | |
MedicationDispense.medication[x].coding.system | 1.. | |
MedicationDispense.medication[x].coding.code | 1.. | |
MedicationDispense.authorizingPrescription | Reference(NLLMedicationRequest) | 1..1 |
MedicationDispense.type | 1.. | |
MedicationDispense.type.coding | 1..1 | |
MedicationDispense.type.coding.system | .. | |
MedicationDispense.type.coding.version | .. | |
MedicationDispense.type.coding.code | 1.. | |
MedicationDispense.quantity | .. | |
MedicationDispense.quantity.value | 1.. | |
MedicationDispense.whenHandedOver | .. | |
MedicationDispense.note | ..1 | |
MedicationDispense.note.text | .. | |
MedicationDispense.dosageInstruction | NLLDosage | .. |
MedicationDispense.dosageInstruction.sequence | .. | |
MedicationDispense.substitution | .. | |
MedicationDispense.substitution.wasSubstituted | .. | |
MedicationDispense.detectedIssue | Reference(NLLDetectedIssue) | .. |
Details
Description of all elements can be found here, Element descriptions.
Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.
Dosage
The dosageInstruction on a MedicationDispense authorized by a MedicationRequest in electronic format, should only be used if the dosageInstruction on the MedicationDispense differs from the dosageInstruction on the MedicationRequest. Otherwise the dosageInstruction on the MedicationDispense must be empty, which means that the dosageInstruction on the MedicationRequest will be used.
How to use the elements in dosageInstruction (the BackBoneElement Dosage) is described on the page Dosage and in the Handbok för vård- och apotekstjänster. Message examples for dosages are available on the page Dosage - Create
Medication dispense statuses
The following statuses are used within NLL for dispenses.
ValueSet medication-dispense-status
Parameter | Comment |
---|---|
Completed | The dispensed product has been picked up (sv: Expedierat). |
Cancelled | The dispensed product is not picked up by the patient (sv: Borttaget). |
Medication dispense types
The following types are used within NLL for dispenses.
Code | Display |
---|---|
DD | Dose dispensed fill (sv: Dosdispenserat uttag). |
SP | Standard packing fill (sv: Helförpackningsuttag). |
TF | Trial fill (sv: Startförpackning). |
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | yes | See below for supported search options. |
Insert (POST) | yes | Create a new dispense. NB! When dispatching more than one dispense at the same occasion, a Bundle conforming to the NLLDispatch profile must be used. |
Update (PUT) | yes | Change a dispense by either adjusting quantity, medication or reversing previous dispense. |
Delete (DEL) | no | |
Operation (GET, POST) | yes | See below for supported extended operations. |
When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.
Query operations
Supported queries
The following query alternatives are available for this resource.
../nllDispatchId/[id]
../MedicationDispense/[id]
../MedicationDispense/[id]/_history{/[vid]}
../MedicationDispense?[parameters]
Parameter chains:Chain 1
patient._id=[id]
{&hasAuthorizingPrescription=true}
{&nllDispatchId=[string]}
{&whenhandedover=ge[date]}
Chain 2
medicationrequest._id=[id]
{&whenhandedover=ge[date]}
Chain 3
authorizingPrescriptions=[id]{,[id]...}
Compartment searches
Supported searches on a compartment. This kind of search returns a bundle with the related resources.
../MedicationDispense/[id]/Provenance
returns all related provenances.../MedicationRequest/[id]/MedicationDispense
returns all related medication dispenses (NLLMedicationDispenses).
Include & reverse includes
Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.
../MedicationDispense?[parameters]&_revinclude=Provenance:target:MedicationDispense
returns one or more MedicationDispenses together with their Provenances. The Provenance returned is the one pointing at the returned version of the MedicationDispense. See above for a list of valid parameters.
Example: ../MedicationDispense?patient._id=<uuid>&whenhandedover=ge[date]&_revinclude=Provenance:target:MedicationDispense
returns the patient's medication dispenses made on or after the selected date including one provenance per medication dispense.
For generic information about how to search in FHIR look here.
Search parameters
The table below shows all supported search parameters.
Search parameter | Description | Comment |
---|---|---|
MedicationDispense/[id] | A read based on the logical ID (UUID) of a medication dispense../MedicationDispense/<uuid> |
|
_history | A vread to get all versions of a medication dispense../MedicationDispense/<uuid>/_history |
|
_history/[vid] | A vread to get a specific version of a medication dispense../MedicationDispense/<uuid>/_history/3 |
|
patient._id | UUID of the patient. Either patient reference or medication request reference must be part of the query and they are mutually exclusive..?patient._id=<uuid> |
|
medicationrequest._id | UUID of the authorizing prescription (MedicationRequest). Either prescription reference or patient reference must be part of the query and they are mutually exclusive...?medicationrequest._id=<uuid> |
|
hasAuthorizingPrescription | Dispenses related to an electronic prescription..&hasAuthorizingPrescription=true |
If not specified all type of dispenses are returned |
nllDispatchId | Id of a dispatch..&nllDispatchId=123 |
|
whenhandedover | Date, greater than or equal, when the medication was dispensed at the pharmacy..&whenhandedover=ge2021-08-31 |
Required prefix: ge |
authorizingPrescriptions | A list of UUIDs of authorizing prescriptions (MedicationRequests)..?authorizingPrescriptions=4f0a61d5-c3d9-4803-b4c2-ea53732b086b,05b21687-fe0a-4311-b32f-a42108477b8f |
Other operations
Operation | Comment | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
$verify NLLVerify |
Invocations
This operation does NOT change content Parameters (In)
Return Values (Out)
Must be invoked with a HTTP POST. This operation is invoked on MedicationDispense and MedicationRequest resources to verify them according to the Automatic Format and Constitution Control (sv. Automatiska format- och författningskontroller AFF-kontroller). It is also possible to verify a set of MedicationDispenses by using $verify on the service base and providing a Bundle according to NLLDispatch or NLLTransactionBundle. NB! When providing a Bundle only MedicationDispenses will be verified accroding to the Automatic Format and Constitution Control. It is important that the content of the resource parameter matches the end-point of the request. A Provenance object must be included in the HTTP header X-Provenance. |