Page Status: updated 2024-10-28

NLLDispensePaperPrescription (MedicationDispense)

Page index

Introduction

The MedicationDispense resource, shown in the profile NLLDispensePaperPrescription, is used when a dispense is made based on a paper prescription; i.e. the dispense is authorized by a prescription that currently is NOT electronically registered in the Swedish National Medication List.

Note that one major difference between the profiles NLLMedicationDispense (used for dispenses where the prescription is electronically registered in the National Medication List) and NLLDispensePaperPrescription is how data about the authorizing prescription is provided. NLLMedicationDispense has a reference to the prescription, whilst NLLDispensePaperPrescription has a set of attributes that contain prescription details.

Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources

Overview

idS Σ0..1string
id0..1string
extensionI0..*Extension
versionIdS Σ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
nllDispatchIdS I0..1Extension(string)
nllNumberOfPackagesDispensedS I0..1Extension(positiveInt)
nllActorDispatchIdS I0..1Extension(string)
nllDispatchRowNoS I0..1Extension(decimal)
nllBenefitChoiceCodeS I0..1Extension(code)Binding
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueReferenceReference(NLLPractitioner)
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCodecode
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCodecode
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBooleanboolean
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDatedate
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uriFixed Value
valueS Σ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
url1..1uriFixed Value
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
url1..1uriFixed Value
modifierExtension?! I0..*Extension
identifier0..*Identifier
partOf0..*Reference(Procedure)
statusS Σ ?!1..1codeBinding
statusReasonCodeableConceptCodeableConcept
statusReasonReferenceReference(DetectedIssue)
category0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
subjectS Σ1..1Reference(NLLPatient)
context0..1Reference(Encounter | EpisodeOfCare)
supportingInformation0..*Reference(Resource)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
function0..1CodeableConcept
actor1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
location0..1Reference(Location)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
valueS Σ1..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ0..1string
systemΣ I0..1uri
codeΣ0..1code
daysSupply0..1SimpleQuantity
whenPreparedΣ0..1dateTime
whenHandedOverS1..1dateTime
destination0..1Reference(Location)
receiver0..*Reference(Patient | Practitioner)
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionS Σ1..1string
timingΣ0..1Timing
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
siteΣ0..1CodeableConcept
routeΣ0..1CodeableConcept
methodΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
typeΣ0..1CodeableConcept
doseRangeRange
doseQuantitySimpleQuantity
rateRatioRatio
rateRangeRange
rateQuantitySimpleQuantity
maxDosePerPeriodΣ0..1Ratio
maxDosePerAdministrationΣ0..1SimpleQuantity
maxDosePerLifetimeΣ0..1SimpleQuantity
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
wasSubstitutedS1..1boolean
type0..1CodeableConcept
reason0..*CodeableConcept
responsibleParty0..*Reference(Practitioner | PractitionerRole)
detectedIssueS0..*Reference(NLLDetectedIssue)
eventHistory0..*Reference(Provenance)
MedicationDispense
DefinitionA dispense for a paper prescription is a medication dispense where the authorizing prescription is not registererd in the National Swedish Medication List but is instead made based on a prescription in paper format.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • mdd-1: whenHandedOver cannot be before whenPrepared
    whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Supply[moodCode=EVN]
MedicationDispense.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • EHM: Logiskt id för uttag pappersrecept
MedicationDispense.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Uttagsversion för uttag pappersrecept
MedicationDispense.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.meta.source
DefinitionA 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.
Cardinality0...1
Typeuri
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.meta.profile
DefinitionA 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).
Cardinality0...*
Typecanonical(StructureDefinition)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

security-labels (extensible)
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.meta.security.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.meta.security.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.meta.security.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicationDispense.meta.security.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicationDispense.meta.security.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicationDispense.meta.security.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicationDispense.meta.security.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicationDispense.meta.tag
DefinitionTags 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.
Cardinality0...*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MedicationDispense.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
MedicationDispense.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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
  • rim: N/A
MedicationDispense.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
Cardinality1...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MedicationDispense.extension:nllDispatchId
DefinitionValue 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 .
Cardinality0...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
  • EHM: Expeditions-id
MedicationDispense.extension:nllNumberOfPackagesDispensed
DefinitionNumber of packages dspensed
Cardinality0...1
TypeExtension(positiveInt)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
  • EHM: Antal expedierade förpackningar
MedicationDispense.extension:nllActorDispatchId
DefinitionThe identifier of the actors dispatch in which the dispense was made. Mandatory when creating a dispense for a paper prescription. Not present in all legacy data.
Cardinality0...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
Comments

Maximum string length: 12

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
  • EHM: Aktörens expeditions-id
MedicationDispense.extension:nllDispatchRowNo
DefinitionUsed when communicationg an error or warning for a MedicationDispense within a dispatch. The DispatchRowNo (ExpeditionsRadNummer) uniquely identifies a MediationDispense within a dispatch. Mandatory when creating a detached dispense.
Cardinality0...1
TypeExtension(decimal)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
  • EHM: Aktörens expeditionsradnummer
MedicationDispense.extension:nllBenefitChoiceCode
DefinitionType of benefit for the dispense. Only used for validation (input only).
Cardinality0...1
TypeExtension(code)
Bindingbenefit-choices (required)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
  • EHM: Förmånsval
MedicationDispense.extension:nllPrescriptionDetails
DefinitionInformation from the authorizing prescription
Cardinality1...1
TypeExtension(Complex)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality1...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate
DefinitionDate when prescription was initially authored.
Only used for validation (input only).
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Utfärdandedatum
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllPrescriptionDate

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber
DefinitionThe prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile).
Cardinality1...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Utfärdande förskrivare
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllPrescriber

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeReference(NLLPractitioner)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis
DefinitionOriginal format of the prescription. Only used for validation. Input only. For a detached dispense the allowed values are PAPER or PHONE.
Cardinality0...1
TypeExtension
Bindingregistration-basis (required)
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Typ av registeringsunderlag
MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllRegistrationBasis

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typecode
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode
DefinitionNB! Deprecated, Practitioner.address.country should be used. Country code, as defined on the authorizing prescription ISO 3166-1 alpha-2 Example: NO (Norway)
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

Maximum string length: 2

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Landskod
MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllCountryCode

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed
DefinitionIndicates if medication may be substituted (sv: generisk substitution tillåten)
Only used for validation (input only).
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Substitution tillåten
MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllSubstitutionAllowed

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore
DefinitionNot used for dose dispensed prescriptions The first dispense must occur before this date. If not, the prescription is invalidated.
Only used for validation (input only).
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Första uttag före
MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllFirstDispenseBefore

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typedate
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter
DefinitionThe prescribers cost center code when making the prescription. Used for benefit billing within the regions.
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

Minimum string length: 3 Maximum string length: 13

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Kostnadsställe (arbetsplatskod)
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

nllPrescriberCostCenter

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
TypeIdentifier
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].system
DefinitionThe cost center needs to be in the form of a "workplace code" (sv arbetsplatskod). Workplace codes are avaliabnle in the system ARKO at the Swedish eHealth Agency.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://electronichealth.se/identifier/arbetsplatskod

Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].value
DefinitionThe value of the cost center needs to be in the form of a "workplace code" (sv arbetsplatskod). Workplace codes are avaliabnle in the system ARKO at the Swedish eHealth Agency.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
MedicationDispense.extension:nllPrescriptionDetails.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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/NLLPrescriptionDetails

Mappings
  • rim: N/A
MedicationDispense.extension:nllPrescriptionDetails.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting
DefinitionCrediting details for a dispense. Only used when crediting a dispense.
Cardinality0...1
TypeExtension(Complex)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality2...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate
DefinitionThe date when the dispense was credited.
Cardinality1...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Krediteringstidpunkt
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId
DefinitionThe id of the crediting dispatch.
Cardinality1...1
TypeExtension
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Krediterande expeditions-id
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo
DefinitionNB! 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'.
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • EHM: Aktörens krediterande expeditionsradnummer
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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
  • rim: N/A
MedicationDispense.extension:nllDispenseCrediting.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MedicationDispense.identifier
DefinitionIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
Cardinality0...*
TypeIdentifier
Comments

This is a business identifier, not a resource identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: .id
  • rx-dispense-rmim: CombinedMedicationDispense.id
MedicationDispense.partOf
DefinitionThe procedure that trigger the dispense.
Cardinality0...*
TypeReference(Procedure)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.partOf
  • rim: .outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]
MedicationDispense.status
DefinitionNote! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat).
Cardinality1...1
Typecode
Binding

A coded concept specifying the state of the dispense event.

medication-dispense-status (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
  • rim: .statusCode
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.statusCode
  • EHM: Uttagsstatus
MedicationDispense.statusReason[x]
DefinitionIndicates the reason why a dispense was not performed.
Cardinality0...1
TypeCodeableConcept
Binding

A code describing why a dispense was not performed.

MedicationDispense Status Reason Codes (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.statusReason
  • rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="not done reason"].value
MedicationDispense.category
DefinitionIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
Cardinality0...1
TypeCodeableConcept
Binding

A code describing where the dispensed medication is expected to be consumed or administered.

MedicationDispense Category Codes (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication dispense"].value
MedicationDispense.medication[x]
DefinitionIdentifies the medical product being prescribed. The codes used are Swedish NplId from medical product, 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 prescribing a medication. For a reimbursed consumable, only Varunr shall be provided.
Cardinality1...1
TypeCodeableConcept
Binding

Swedish medicine packages and reimbursed consumables.

http://electronichealth.se/fhir/ValueSet/medicines-consumables (required)
Must SupportTrue
SummaryTrue
Comments

_

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.code
  • w5: FiveWs.what[x]
  • v2: RXD-2-Dispense/Give Code
  • rim: .participation[typeCode=PRD].role
  • rx-dispense-rmim: CombinedMedicationRequest.component1.AdministrationRequest.consumable
MedicationDispense.medication[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.medication[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...*
TypeCoding
Must SupportTrue
SummaryTrue
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.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicationDispense.medication[x].coding:nplid
DefinitionA unique identifier of a medical product according to "Nationellt produktregister för läkemedel" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)
Cardinality0...1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
  • EHM: NPL-id
MedicationDispense.medication[x].coding:nplid.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:nplid.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:nplid.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://electronichealth.se/fhir/NamingSystem/nplid

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicationDispense.medication[x].coding:nplid.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicationDispense.medication[x].coding:nplid.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicationDispense.medication[x].coding:nplid.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicationDispense.medication[x].coding:nplid.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicationDispense.medication[x].coding:nplpackid
DefinitionA 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)
Cardinality0...1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
  • EHM: NPL-pack-id
MedicationDispense.medication[x].coding:nplpackid.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:nplpackid.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:nplpackid.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://electronichealth.se/fhir/NamingSystem/nplpackid

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicationDispense.medication[x].coding:nplpackid.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicationDispense.medication[x].coding:nplpackid.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicationDispense.medication[x].coding:nplpackid.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicationDispense.medication[x].coding:nplpackid.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicationDispense.medication[x].coding:varunr
DefinitionA 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.
Cardinality0...1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
  • EHM: Varunummer
MedicationDispense.medication[x].coding:varunr.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:varunr.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.medication[x].coding:varunr.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://electronichealth.se/fhir/NamingSystem/varunr

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicationDispense.medication[x].coding:varunr.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicationDispense.medication[x].coding:varunr.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Minimum string length: 6 Maximum string length: 6

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicationDispense.medication[x].coding:varunr.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicationDispense.medication[x].coding:varunr.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicationDispense.medication[x].text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
MedicationDispense.subject
DefinitionA patient with personal identification number (sv: personnummer) must be referenced, other cases must be handled by containing the patient resource.
Cardinality1...1
TypeReference(NLLPatient)
Must SupportTrue
SummaryTrue
Comments

SubstanceAdministration->subject->Patient.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • v2: PID-3-Patient ID List
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: FiveWs.subject
  • EHM: Patient
  • EHM: Patientreferens
MedicationDispense.context
DefinitionThe encounter or episode of care that establishes the context for this event.
Cardinality0...1
TypeReference(Encounter | EpisodeOfCare)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.context
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]
MedicationDispense.supportingInformation
DefinitionAdditional information that supports the medication being dispensed.
Cardinality0...*
TypeReference(Resource)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.context
  • rim: .outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]
MedicationDispense.performer
DefinitionIndicates who or what performed the event.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer
  • rim: .participation[typeCode=PRF]
MedicationDispense.performer.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.performer.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.performer.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MedicationDispense.performer.function
DefinitionDistinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.
Cardinality0...1
TypeCodeableConcept
Binding

A code describing the role an individual played in dispensing a medication.

MedicationDispense Performer Function Codes (example)
Requirements

Allows disambiguation of the types of involvement of different performers.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: participation[typeCode=PRF].functionCode
MedicationDispense.performer.actor
DefinitionThe device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
Cardinality1...1
TypeReference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer.actor
  • rim: .role
MedicationDispense.location
DefinitionThe principal physical location where the dispense was performed.
Cardinality0...1
TypeReference(Location)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .participation[typeCode=LOC].role
MedicationDispense.authorizingPrescription
DefinitionIndicates the medication order that is being dispensed against. In this profile, the authorizing prescription is always in paper form (current format) and/or there is no electronic presecription in NLL to refer to (sv: uttag där underlaget är ett papper eller ett utländskt e-recept)
Cardinality0...0
TypeReference(MedicationRequest)
Comments

Maps to basedOn in Event logical model.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.basedOn
  • v2: ORC-2 Placer Order Number
  • rim: .outboundRelationship[typeCode=FLFS].target[moodCode=RQO]
  • rx-dispense-rmim: CombinedMedicationDispense.inFulfillmentOf
MedicationDispense.authorizingPrescription.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.authorizingPrescription.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.authorizingPrescription.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...0
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.authorizingPrescription.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.authorizingPrescription.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
MedicationDispense.authorizingPrescription.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MedicationDispense.type
DefinitionType 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). Dose dispensed fill can no longer occur for a dispense of a paper prescription. The code DD will be removed from the value set used by this profile in a future release.
Cardinality1...1
TypeCodeableConcept
Binding

Indicates the type of dispensing event that is performed, e.g. Standard packing fill, Trial fill or Dose dispense refill

dispense-types (required)
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXD-33-Dispense Type
  • rim: .code
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.code
  • EHM: Uttagstyp
MedicationDispense.type.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.type.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.type.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicationDispense.type.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.type.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.type.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicationDispense.type.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicationDispense.type.coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicationDispense.type.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicationDispense.type.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicationDispense.type.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
MedicationDispense.quantity
DefinitionThe amount of medication that has been dispensed. Includes unit of measure.
Cardinality0...1
TypeSimpleQuantity
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system
  • rim: .quantity
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.quantity
  • EHM: Expedierad mängd
MedicationDispense.quantity.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.quantity.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.quantity.value
DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value.
Cardinality1...1
Typedecimal
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
MedicationDispense.quantity.comparator
DefinitionNot allowed to be used in this context
Cardinality0...0
Typecode
Binding

How the Quantity should be understood and represented.

QuantityComparator (required)
ModifierTrue
SummaryTrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SN.1 / CQ.1
  • rim: IVL properties
MedicationDispense.quantity.unit
DefinitionA human-readable form of the unit.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
MedicationDispense.quantity.system
DefinitionThe identification of the system that provides the coded form of the unit.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

Need to know the system that defines the coded form of the unit.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
MedicationDispense.quantity.code
DefinitionA computer processable form of the unit in some unit representation system.
Cardinality0...1
Typecode
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
MedicationDispense.daysSupply
DefinitionThe amount of medication expressed as a timing amount.
Cardinality0...1
TypeSimpleQuantity
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: TQ1.6 Timing/Quantity Segment Service Duration. Prior to v2.5, ORC.7.3 Common Order Segment / Quantity/Timing / Duration component. This is a formatted string, first character for the time unit (e.g., D=days), followed by the value. For example, “D14” represents “14 days supply” From v2.5 on, TQ1.6 Timing/Quantity Segment / Service Duration. This is a CQ data type (<Quantity (NM)> ^ <Units (CWE)>), thus for days supply, assuming the unit of measure is “days”, the numeric value is TQ1.6.1 (…|14^ For backwards compatibility, ORC.7 was permitted through v2.6. Both forms (field and segment) may be present in v2.5, v2.5.1, and v2.6
  • rim: effectiveUseTime
MedicationDispense.whenPrepared
DefinitionThe time when the dispensed product was packaged and reviewed.
Cardinality0...1
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXD-3-Date/Time Dispensed
  • rim: .effectiveTime[xmi:type=IVL_TS].low
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.effectiveTime
MedicationDispense.whenHandedOver
DefinitionThe time the dispensed product was provided to the patient or their representative.
Cardinality1...1
TypedateTime
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.occurrence[x]
  • v2: RXD-3-Date/Time Dispensed
  • rim: .effectiveTime[xmi:type=IVL_TS].high
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.effectiveTime
  • EHM: Expedieringstidpunkt
MedicationDispense.destination
DefinitionIdentification of the facility/location where the medication was shipped to, as part of the dispense event.
Cardinality0...1
TypeReference(Location)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address
  • rim: .participation[typeCode=DST].role
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.destination
MedicationDispense.receiver
DefinitionIdentifies 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.
Cardinality0...*
TypeReference(Patient | Practitioner)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .participation[typeCode=RCV].role
  • rx-dispense-rmim: CombinedMedicationDispense.SupplyEvent.receiver
MedicationDispense.note
DefinitionExtra information about the dispense that could not be conveyed in the other attributes.
Cardinality0...*
TypeAnnotation
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.note
  • v2: RXD-9 Dispense Notes
  • rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]
MedicationDispense.dosageInstruction
DefinitionIndicates how the medication is to be used by the patient.
Cardinality0...1
TypeDosage
Must SupportTrue
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
MedicationDispense.dosageInstruction.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MedicationDispense.dosageInstruction.sequence
DefinitionIndicates the order in which the dosage instructions should be applied or interpreted.
Cardinality0...1
Typeinteger
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: TQ1-1
  • rim: .text
MedicationDispense.dosageInstruction.text
DefinitionFree text dosage instructions e.g. SIG.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-6; RXE-21
  • rim: .text
MedicationDispense.dosageInstruction.additionalInstruction
DefinitionSupplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Cardinality0...*
TypeCodeableConcept
Binding

A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

SNOMEDCTAdditionalDosageInstructions (example)
SummaryTrue
Requirements

Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

Comments

Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-7
  • rim: .text
MedicationDispense.dosageInstruction.patientInstruction
DefinitionInstructions in terms that are understood by the patient or consumer.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Maximum string length: 1016

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-7
  • rim: .text
  • EHM: Doseringsinstruktion
MedicationDispense.dosageInstruction.timing
DefinitionWhen medication should be administered.
Cardinality0...1
TypeTiming
SummaryTrue
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

This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
MedicationDispense.dosageInstruction.asNeeded[x]
DefinitionIndicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
Cardinality0...1
Typeboolean
Binding

A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

SNOMEDCTMedicationAsNeededReasonCodes (example)
SummaryTrue
Comments

Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: TQ1-9
  • rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept
MedicationDispense.dosageInstruction.site
DefinitionBody site to administer to.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing the site location the medicine enters into or onto the body.

SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
SummaryTrue
Requirements

A coded specification of the anatomic site where the medication first enters the body.

Comments

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXR-2
  • rim: .approachSiteCode
MedicationDispense.dosageInstruction.route
DefinitionHow drug should enter body.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)
SummaryTrue
Requirements

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXR-1
  • rim: .routeCode
MedicationDispense.dosageInstruction.method
DefinitionTechnique for administering medication.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing the technique by which the medicine is administered.

SNOMEDCTAdministrationMethodCodes (example)
SummaryTrue
Requirements

A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

Comments

Terminologies used often pre-coordinate this term with the route and or form of administration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXR-4
  • rim: .doseQuantity
MedicationDispense.dosageInstruction.doseAndRate
DefinitionThe amount of medication administered.
Cardinality0...*
TypeElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: TQ1-2
MedicationDispense.dosageInstruction.doseAndRate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.doseAndRate.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.doseAndRate.type
DefinitionThe kind of dose or rate specified, for example, ordered or calculated.
Cardinality0...1
TypeCodeableConcept
Binding

The kind of dose or rate specified.

DoseAndRateType (example)
SummaryTrue
Requirements

If the type is not populated, assume to be "ordered".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-21; RXE-23
MedicationDispense.dosageInstruction.doseAndRate.dose[x]
DefinitionAmount of medication per dose.
Cardinality0...1
TypeRange
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-2, RXE-3
  • rim: .doseQuantity
MedicationDispense.dosageInstruction.doseAndRate.rate[x]
DefinitionAmount of medication per unit of time.
Cardinality0...1
TypeRatio
SummaryTrue
Requirements

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXE22, RXE23, RXE-24
  • rim: .rateQuantity
MedicationDispense.dosageInstruction.maxDosePerPeriod
DefinitionUpper limit on medication per unit of time.
Cardinality0...1
TypeRatio
SummaryTrue
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

This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-23, RXE-19
  • rim: .maxDoseQuantity
MedicationDispense.dosageInstruction.maxDosePerAdministration
DefinitionUpper limit on medication per administration.
Cardinality0...1
TypeSimpleQuantity
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: not supported
MedicationDispense.dosageInstruction.maxDosePerLifetime
DefinitionUpper limit on medication per lifetime of the patient.
Cardinality0...1
TypeSimpleQuantity
SummaryTrue
Requirements

The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: not supported
MedicationDispense.substitution
DefinitionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
Cardinality0...1
TypeBackboneElement
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]
  • rx-dispense-rmim: CombinedMedicationDispense.substitutionMade
MedicationDispense.substitution.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MedicationDispense.substitution.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MedicationDispense.substitution.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MedicationDispense.substitution.wasSubstituted
DefinitionTrue if the dispenser dispensed a different drug or product from what was prescribed. Only used for validation (input only).
Cardinality1...1
Typeboolean
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actionNegationInd
  • EHM: Generikautbyte utfört
MedicationDispense.substitution.type
DefinitionA code signifying whether a different drug was dispensed from what was prescribed.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

v3.ActSubstanceAdminSubstitutionCode (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-9-Allow Substitutions / RXE-9-Substitution Status
  • rim: .code
  • rx-dispense-rmim: CombinedMedicationDispense.substitutionMade.code
MedicationDispense.substitution.reason
DefinitionIndicates the reason for the substitution (or lack of substitution) from what was prescribed.
Cardinality0...*
TypeCodeableConcept
Binding

A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

v3.SubstanceAdminSubstitutionReason (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .reasonCode
  • rx-dispense-rmim: CombinedMedicationDispense.substitutionMade.reasonCode
MedicationDispense.substitution.responsibleParty
DefinitionThe person or organization that has primary responsibility for the substitution.
Cardinality0...*
TypeReference(Practitioner | PractitionerRole)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .participation[typeCode=PFM].role[classCode=ASSIGN]
  • rx-dispense-rmim: CombinedMedicationDispense.substitutionMade.ResponsibleParty
MedicationDispense.detectedIssue
DefinitionFOR FUTURE USE, SHOULD NOT BE USED! 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.
Cardinality0...*
TypeReference(NLLDetectedIssue)
Must SupportTrue
AliasContraindication, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value
  • EHM: Accepterade varningar
MedicationDispense.eventHistory
DefinitionA summary of the events of interest that have occurred, such as when the dispense was verified.
Cardinality0...*
TypeReference(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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://electronichealth.se/fhir/StructureDefinition/NLLDispensePaperPrescription" />
    <version value="1.2.0" />
    <name value="NLLDispensePaperPrescription" />
    <status value="active" />
    <date value="2024-08-28" />
    <publisher value="Swedish eHealth Agency" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="EHM" />
        <uri value="http://ehalsomyndigheten.se" />
        <name value="E-h&#228;lsomyndighetens internal model" />
    </mapping>
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="rx-dispense-rmim" />
        <uri value="http://www.hl7.org/v3/PORX_RM020070UV" />
        <name value="V3 Pharmacy Dispense RMIM" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </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 paper prescription" />
            <definition value="A dispense for a paper prescription is a medication dispense where the authorizing prescription is not registererd in the National Swedish Medication List but is instead made based on a prescription in paper format." />
        </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&#246;r uttag pappersrecept" />
            </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 f&#246;r uttag pappersrecept" />
            </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="1" />
        </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 ." />
            <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:nllNumberOfPackagesDispensed">
            <path value="MedicationDispense.extension" />
            <sliceName value="nllNumberOfPackagesDispensed" />
            <short value="Number of packages dspensed" />
            <definition value="Number of packages dspensed" />
            <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&#246;rpackningar" />
            </mapping>
        </element>
        <element id="MedicationDispense.extension:nllActorDispatchId">
            <path value="MedicationDispense.extension" />
            <sliceName value="nllActorDispatchId" />
            <short value="The identifier of the actors dispatch in which the dispense was made" />
            <definition value="The identifier of the actors dispatch in which the dispense was made. Mandatory when creating a dispense for a paper prescription. Not present in all legacy data." />
            <comment value="Maximum string length: 12" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Akt&#246;rens expeditions-id" />
            </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.\nMandatory when creating a detached dispense." />
            <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&#246;rens expeditionsradnummer" />
            </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. Only used for validation (input only)." />
            <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&#246;rm&#229;nsval" />
            </mapping>
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails">
            <path value="MedicationDispense.extension" />
            <sliceName value="nllPrescriptionDetails" />
            <short value="Information from the authorizing prescription" />
            <definition value="Information from the authorizing prescription" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllPrescriptionDate" />
            <definition value="Date when prescription was initially authored. &lt;br&gt;\nOnly used for validation (input only)." />
            <comment value="_" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllPrescriber" />
            <short value="Prescriber" />
            <definition value="The prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile)." />
            <comment value="_" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllRegistrationBasis" />
            <comment value="_" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllCountryCode" />
            <short value="Deprecated. Country code" />
            <definition value="NB! Deprecated, Practitioner.address.country should be used.\n\nCountry code, as defined on the authorizing prescription\nISO 3166-1 alpha-2\nExample: NO (Norway)" />
            <comment value="Maximum string length: 2" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllSubstitutionAllowed" />
            <definition value="Indicates if medication may be substituted (sv: generisk substitution till&#229;ten) &lt;br&gt;\nOnly used for validation (input only)." />
            <comment value="_" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllFirstDispenseBefore" />
            <definition value="Not used for dose dispensed prescriptions\nThe first dispense must occur before this date. If not, the prescription is invalidated.&lt;br&gt;\nOnly used for validation (input only)." />
            <comment value="_" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter">
            <path value="MedicationDispense.extension.extension" />
            <sliceName value="nllPrescriberCostCenter" />
            <short value="The prescribers cost center" />
            <definition value="The prescribers cost center code when making the prescription. Used for benefit billing within the regions." />
            <comment value="Minimum string length: 3\nMaximum string length: 13" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.extension:nllDispenseCrediting">
            <path value="MedicationDispense.extension" />
            <sliceName value="nllDispenseCrediting" />
            <definition value="Crediting details for a dispense. Only used when crediting a dispense." />
            <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" />
            <comment value="_" />
            <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" />
            <definition value="Note! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat)." />
            <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" />
            <definition value="Identifies the medical product being prescribed. The codes used are Swedish NplId from medical product, 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 prescribing a medication.\nFor a reimbursed consumable, only Varunr shall be provided." />
            <comment value="_" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <description value="Swedish medicine packages and reimbursed consumables." />
                <valueSet value="http://electronichealth.se/fhir/ValueSet/medicines-consumables" />
            </binding>
        </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 &quot;Nationellt produktregister f&#246;r l&#228;kemedel&quot; provided by the Swedish Medical Products Agency (sv L&#228;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 &quot;Nationellt produktregister f&#246;r l&#228;kemedel&quot; provided by the Swedish Medical Products Agency (sv L&#228;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 &quot;Nationellt produktregister f&#246;r l&#228;kemedel&quot; provided by the Swedish Medical Products Agency (sv L&#228;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.subject">
            <path value="MedicationDispense.subject" />
            <short value="Which patient the dispense is for" />
            <definition value="A patient with personal identification number (sv: personnummer) must be referenced, other cases must be handled by containing the patient resource." />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/StructureDefinition/NLLPatient" />
                <aggregation value="contained" />
                <aggregation value="referenced" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Patient" />
            </mapping>
            <mapping>
                <identity value="EHM" />
                <map value="Patientreferens" />
            </mapping>
        </element>
        <element id="MedicationDispense.authorizingPrescription">
            <path value="MedicationDispense.authorizingPrescription" />
            <definition value="Indicates the medication order that is being dispensed against. In this profile, the authorizing prescription is always in paper form (current format)  and/or there is no electronic presecription in NLL to refer to (sv: uttag d&#228;r underlaget &#228;r ett papper eller ett utl&#228;ndskt e-recept)" />
            <max value="0" />
        </element>
        <element id="MedicationDispense.authorizingPrescription.reference">
            <path value="MedicationDispense.authorizingPrescription.reference" />
            <max value="0" />
        </element>
        <element id="MedicationDispense.authorizingPrescription.identifier">
            <path value="MedicationDispense.authorizingPrescription.identifier" />
            <max value="0" />
        </element>
        <element id="MedicationDispense.type">
            <path value="MedicationDispense.type" />
            <short value="Standard packing fill, Dose dispensed fill or Trial fill" />
            <definition value="Type is used for specifing if the dispense was a &quot;Standard packing fill&quot;, &quot;Trial fill&quot; (startf&#246;rpackning) or &quot;Dose dispensed fill&quot; in the Swedish National Medication List. (Trial fill is not used for dose dispensed fills).\nDose dispensed fill can no longer occur for a dispense of a paper prescription. The code DD will be removed from the value set used by this profile in a future release." />
            <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" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Expedierad m&#228;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" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Expedieringstidpunkt" />
            </mapping>
        </element>
        <element id="MedicationDispense.dosageInstruction">
            <path value="MedicationDispense.dosageInstruction" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.dosageInstruction.patientInstruction">
            <path value="MedicationDispense.dosageInstruction.patientInstruction" />
            <comment value="Maximum string length: 1016" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Doseringsinstruktion" />
            </mapping>
        </element>
        <element id="MedicationDispense.substitution">
            <path value="MedicationDispense.substitution" />
            <mustSupport value="true" />
        </element>
        <element id="MedicationDispense.substitution.wasSubstituted">
            <path value="MedicationDispense.substitution.wasSubstituted" />
            <definition value="True if the dispenser dispensed a different drug or product from what was prescribed.\nOnly used for validation (input only)." />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Generikautbyte utf&#246;rt" />
            </mapping>
        </element>
        <element id="MedicationDispense.detectedIssue">
            <path value="MedicationDispense.detectedIssue" />
            <short value="Automatic Format and Constitution Control warning (AFF varning)" />
            <definition value="FOR FUTURE USE, SHOULD NOT BE USED!\nAccepted 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",
    "url": "http://electronichealth.se/fhir/StructureDefinition/NLLDispensePaperPrescription",
    "version": "1.2.0",
    "name": "NLLDispensePaperPrescription",
    "status": "active",
    "date": "2024-08-28",
    "publisher": "Swedish eHealth Agency",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "EHM",
            "uri": "http://ehalsomyndigheten.se",
            "name": "E-hälsomyndighetens internal model"
        },
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "rx-dispense-rmim",
            "uri": "http://www.hl7.org/v3/PORX_RM020070UV",
            "name": "V3 Pharmacy Dispense RMIM"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        }
    ],
    "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 paper prescription",
                "definition": "A dispense for a paper prescription is a medication dispense where the authorizing prescription is not registererd in the National Swedish Medication List but is instead made based on a prescription in paper format."
            },
            {
                "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 pappersrecept"
                    }
                ]
            },
            {
                "id": "MedicationDispense.meta",
                "path": "MedicationDispense.meta",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.meta.versionId",
                "path": "MedicationDispense.meta.versionId",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Uttagsversion för uttag pappersrecept"
                    }
                ]
            },
            {
                "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": 1
            },
            {
                "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 .",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchId"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Expeditions-id"
                    }
                ]
            },
            {
                "id": "MedicationDispense.extension:nllNumberOfPackagesDispensed",
                "path": "MedicationDispense.extension",
                "sliceName": "nllNumberOfPackagesDispensed",
                "short": "Number of packages dspensed",
                "definition": "Number of packages dspensed",
                "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 actors dispatch in which the dispense was made",
                "definition": "The identifier of the actors dispatch in which the dispense was made. Mandatory when creating a dispense for a paper prescription. Not present in all legacy data.",
                "comment": "Maximum string length: 12",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Aktörens expeditions-id"
                    }
                ]
            },
            {
                "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.\nMandatory when creating a detached dispense.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchRowNo"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Aktörens expeditionsradnummer"
                    }
                ]
            },
            {
                "id": "MedicationDispense.extension:nllBenefitChoiceCode",
                "path": "MedicationDispense.extension",
                "sliceName": "nllBenefitChoiceCode",
                "short": "Benefit choice",
                "definition": "Type of benefit for the dispense. Only used for validation (input only).",
                "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:nllPrescriptionDetails",
                "path": "MedicationDispense.extension",
                "sliceName": "nllPrescriptionDetails",
                "short": "Information from the authorizing prescription",
                "definition": "Information from the authorizing prescription",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllPrescriptionDate",
                "definition": "Date when prescription was initially authored. <br>\nOnly used for validation (input only).",
                "comment": "_",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllPrescriber",
                "short": "Prescriber",
                "definition": "The prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile).",
                "comment": "_",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllRegistrationBasis",
                "comment": "_",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllCountryCode",
                "short": "Deprecated. Country code",
                "definition": "NB! Deprecated, Practitioner.address.country should be used.\n\nCountry code, as defined on the authorizing prescription\nISO 3166-1 alpha-2\nExample: NO (Norway)",
                "comment": "Maximum string length: 2",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllSubstitutionAllowed",
                "definition": "Indicates if medication may be substituted (sv: generisk substitution tillåten) <br>\nOnly used for validation (input only).",
                "comment": "_",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllFirstDispenseBefore",
                "definition": "Not used for dose dispensed prescriptions\nThe first dispense must occur before this date. If not, the prescription is invalidated.<br>\nOnly used for validation (input only).",
                "comment": "_",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "nllPrescriberCostCenter",
                "short": "The prescribers cost center",
                "definition": "The prescribers cost center code when making the prescription. Used for benefit billing within the regions.",
                "comment": "Minimum string length: 3\nMaximum string length: 13",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllDispenseCrediting",
                "path": "MedicationDispense.extension",
                "sliceName": "nllDispenseCrediting",
                "definition": "Crediting details for a dispense. Only used when crediting a dispense.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDate",
                "path": "MedicationDispense.extension.extension",
                "sliceName": "creditDate",
                "comment": "_",
                "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",
                "definition": "Note! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat).",
                "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",
                "definition": "Identifies the medical product being prescribed. The codes used are Swedish NplId from medical product, 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 prescribing a medication.\nFor a reimbursed consumable, only Varunr shall be provided.",
                "comment": "_",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "Swedish medicine packages and reimbursed consumables.",
                    "valueSet": "http://electronichealth.se/fhir/ValueSet/medicines-consumables"
                }
            },
            {
                "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.subject",
                "path": "MedicationDispense.subject",
                "short": "Which patient the dispense is for",
                "definition": "A patient with personal identification number (sv: personnummer) must be referenced, other cases must be handled by containing the patient resource.",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLPatient"
                        ],
                        "aggregation":  [
                            "contained",
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Patient"
                    },
                    {
                        "identity": "EHM",
                        "map": "Patientreferens"
                    }
                ]
            },
            {
                "id": "MedicationDispense.authorizingPrescription",
                "path": "MedicationDispense.authorizingPrescription",
                "definition": "Indicates the medication order that is being dispensed against. In this profile, the authorizing prescription is always in paper form (current format)  and/or there is no electronic presecription in NLL to refer to (sv: uttag där underlaget är ett papper eller ett utländskt e-recept)",
                "max": "0"
            },
            {
                "id": "MedicationDispense.authorizingPrescription.reference",
                "path": "MedicationDispense.authorizingPrescription.reference",
                "max": "0"
            },
            {
                "id": "MedicationDispense.authorizingPrescription.identifier",
                "path": "MedicationDispense.authorizingPrescription.identifier",
                "max": "0"
            },
            {
                "id": "MedicationDispense.type",
                "path": "MedicationDispense.type",
                "short": "Standard packing fill, Dose dispensed fill or Trial fill",
                "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).\nDose dispensed fill can no longer occur for a dispense of a paper prescription. The code DD will be removed from the value set used by this profile in a future release.",
                "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",
                "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",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Expedieringstidpunkt"
                    }
                ]
            },
            {
                "id": "MedicationDispense.dosageInstruction",
                "path": "MedicationDispense.dosageInstruction",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.dosageInstruction.patientInstruction",
                "path": "MedicationDispense.dosageInstruction.patientInstruction",
                "comment": "Maximum string length: 1016",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Doseringsinstruktion"
                    }
                ]
            },
            {
                "id": "MedicationDispense.substitution",
                "path": "MedicationDispense.substitution",
                "mustSupport": true
            },
            {
                "id": "MedicationDispense.substitution.wasSubstituted",
                "path": "MedicationDispense.substitution.wasSubstituted",
                "definition": "True if the dispenser dispensed a different drug or product from what was prescribed.\nOnly used for validation (input only).",
                "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": "FOR FUTURE USE, SHOULD NOT BE USED!\nAccepted 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.extension1..
MedicationDispense.extensionExtension..
MedicationDispense.extensionExtension..1
MedicationDispense.extensionExtension..
MedicationDispense.extensionExtension..1
MedicationDispense.extensionExtension..1
MedicationDispense.extensionExtension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extensionExtension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.extension.extension..
MedicationDispense.status..
MedicationDispense.medication[x]CodeableConcept..
MedicationDispense.medication[x].coding1..
MedicationDispense.medication[x].coding..1
MedicationDispense.medication[x].coding.system1..
MedicationDispense.medication[x].coding.code1..
MedicationDispense.medication[x].coding..1
MedicationDispense.medication[x].coding.system1..
MedicationDispense.medication[x].coding.code1..
MedicationDispense.medication[x].coding..1
MedicationDispense.medication[x].coding.system1..
MedicationDispense.medication[x].coding.code1..
MedicationDispense.subjectReference(NLLPatient)1..
MedicationDispense.authorizingPrescription..0
MedicationDispense.authorizingPrescription.reference..0
MedicationDispense.authorizingPrescription.identifier..0
MedicationDispense.type1..
MedicationDispense.type.coding1..1
MedicationDispense.type.coding.system..
MedicationDispense.type.coding.version..
MedicationDispense.type.coding.code1..
MedicationDispense.quantity..
MedicationDispense.quantity.value1..
MedicationDispense.whenHandedOver1..
MedicationDispense.dosageInstruction..1
MedicationDispense.dosageInstruction.patientInstruction1..
MedicationDispense.substitution..
MedicationDispense.substitution.wasSubstituted..
MedicationDispense.detectedIssueReference(NLLDetectedIssue)..

Contained resources

References to other resources are based on contained resources in the following cases.

Element Resource Case
subject Patient When a patient is identified by name and birthdate only
nllPrescriptionDetails.nllPrescriber Practitioner Allways

For more information about references and contained resources see Resources - References.

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

For a dispense authorized by a paper prescription the dosageInstruction is limited to only one element, patientInstruction.

General information on 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.

ValueSet dispense-types

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. Only a very limited set of attributes can be updated.
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

Note that a search for MedicationDispense may return both dispenses authorized by electronic prescriptions and dispenses authorized by paper prescriptions. The recommended way to distinguish between the two is to examine the authorizingPrescription attribute, which will contain a reference to a prescription in the first scenario, but be empty in the second scenaio.

The following query alternatives are available for this resource.

  1. ../nllDispatchId/[id]

  2. ../MedicationDispense/[id]

  3. ../MedicationDispense/[id]/_history{/[vid]}

  4. ../MedicationDispense?[parameters]
    Parameter chain:

    patient._id=[id]
    {&hasAuthorizingPrescription=false}
    {&nllDispatchId=[string]}
    {&whenhandedover=ge[date]}

Compartment searches

Supported searches on a compartment. This kind of search returns a bundle with the related resources.

  1. ../MedicationDispense/[id]/Provenance returns all related provenances.

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.

  1. ../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.

Parameter Description Comment
MedicationDispense/[id] A read based on the logical ID (UUID) of a detached 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
..?patient._id=<uuid>
hasAuthorizingPrescription Dispenses related to a paper-based prescription
..&hasAuthorizingPrescription=false
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

Other operations

Operation Comment
$verify
NLLVerify

Invocations

URL: [base]/$verify

URL: [base]/MedicationRequest/$verify URL: [base]/MedicationDispense/$verify

This operation does NOT change content

Parameters (In)

NameCardinalityTypeDocumentation
resource0..1MedicationRequest(NLLMedicationRequest)

The MedicationRequest to be verified. This type of verification must be directed to the medication request end-point [base]/MedicationRequest/$verify.

resource0..1MedicationDispense(NLLMedicationDispense)

The MedicationDispense to be verified. This type of verification must be directed to the medication dispense end-point [base]/MedicationDispense/$verify.

resource0..1MedicationDispense(NLLDispensePaperPrescription)

The MedicationDispense to be verified. This type of verification must be directed to the medication dispense end-point [base]/MedicationDispense/$verify.

resource0..1Bundle(NLLDispatch)

A Bundle containing the MedicationDispenses to be verified. This type of verification must be directed to the service base end-point [base]/$verify.

resource0..1Bundle(NLLTransactionBundle)

A Bundle containing the resources to be verified. NB! Only MedicationDispenses to be verified according to the Automatic Format and Constitution Control (sv. Automatiska format- och författningskontroller AFF-kontroller). This type of verification must be directed to the service base end-point [base]/$verify.

Return Values (Out)

NameCardinalityTypeDocumentation
detectedIssues1..1boolean

Has the value 'true' if any AFF errors or warnings are detected, otherwise 'false'

issues0..1OperationOutcome(NLLOperationOutcome)

The OperationOutcome resource, shown in the profile NLLOperationOutcome is a collection of error, warning, or information messages. If the Automatic Format and Constitution Control (sv. Automatiska format- och författningskontroller AFF-kontroller) returns any errors or warnings, these are displayed as DetectedIssues in an OperationOutcome. No OperationOutcome will be returened if there are no issues.

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.