The Swedish National Medication List, development branch

Element id

MedicationDispense.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

Mappings

EHM: Logiskt id för uttag pappersrecept

There are no (further) constraints on this element

Element id

MedicationDispense.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

versionId

S Σ

0..1

Element id

MedicationDispense.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

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.

Data type

Constraints

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

Mappings

EHM: Uttagsversion för uttag pappersrecept

lastUpdated

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

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.

Data type

Constraints

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

source

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

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.

Data type

canonical(StructureDefinition)

Constraints

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

profile

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

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.

Data type

canonical(StructureDefinition)

Constraints

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

security

S Σ

0..*

CodingBinding

Element id

MedicationDispense.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

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.

Data type

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

security-labels (extensible)

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

system

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

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.

Data type

Constraints

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

version

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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.

Data type

Constraints

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

code

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

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

display

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Data type

Constraints

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

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.meta.security.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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.

Data type

Constraints

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 ]

tag

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

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.

Data type

Binding

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

CommonTags (example)

Constraints

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

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

Data type

Constraints

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

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationDispense.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..1

Narrative

There are no (further) constraints on this element

Element id

MedicationDispense.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

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.

Data type

Narrative

Constraints

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

Mappings

rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

MedicationDispense.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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.

Data type

Resource

Mappings

rim: N/A

extension

1..*

Element id

MedicationDispense.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

nllDispatchId

S C

0..1

Element id

MedicationDispense.extension:nllDispatchId

Short description

The identifier of the dispatch in which the dispense was made

Alternate names

extensions, user content

Definition

Value is treated as an integer, i.e the String can only contain numbers. May be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency .

Comments

Data type

http://electronichealth.se/fhir/StructureDefinition/NLLDispatchId

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

nllNumberOfPackagesDispensed

S C

0..1

Extension(positiveInt)

Element id

MedicationDispense.extension:nllNumberOfPackagesDispensed

Short description

Number of packages dspensed

Alternate names

extensions, user content

Definition

Number of packages dspensed

Comments

Data type

Extension(positiveInt)

Extension URL

http://electronichealth.se/fhir/StructureDefinition/NLLNumberOfPackagesDispensed

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

nllActorDispatchId

S C

0..1

Element id

MedicationDispense.extension:nllActorDispatchId

Short description

The identifier of the actors dispatch in which the dispense was made

Alternate names

extensions, user content

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.

Comments

Maximum string length: 12

Data type

http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

nllDispatchRowNo

S C

0..1

Extension(decimal)

Element id

MedicationDispense.extension:nllDispatchRowNo

Short description

Identier for MedicationDispense within dispatch

Alternate names

extensions, user content

Definition

Used 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.

Comments

Data type

Extension(decimal)

Extension URL

http://electronichealth.se/fhir/StructureDefinition/NLLDispatchRowNo

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

nllBenefitChoiceCode

S C

0..1

Extension(code)Binding

Element id

MedicationDispense.extension:nllBenefitChoiceCode

Short description

Benefit choice

Alternate names

extensions, user content

Definition

Type of benefit for the dispense. Only used for validation (input only).

Comments

Data type

Extension(code)

Extension URL

http://electronichealth.se/fhir/StructureDefinition/NLLBenefitChoiceCode

Binding

benefit-choices (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

nllPrescriptionDetails

S C

1..1

Extension(Complex)

Element id

MedicationDispense.extension:nllPrescriptionDetails

Short description

Information from the authorizing prescription

Alternate names

extensions, user content

Definition

Information from the authorizing prescription

Comments

Data type

Extension(Complex)

Extension URL

http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

nllPrescriptionDate

S C

0..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate

Short description

Date when prescription was initially authored

Alternate names

extensions, user content

Definition

Date when prescription was initially authored. Only used for validation (input only).

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

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.

Data type

Auto value

nllPrescriptionDate

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueDateTime

There are no (further) constraints on this element

Data type

nllPrescriber

S C

1..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber

Short description

Prescriber

Alternate names

extensions, user content

Definition

The prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile).

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Reference(NLLPractitioner)

Auto value

nllPrescriber

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueReference

There are no (further) constraints on this element

Data type

Reference(NLLPractitioner)

Allowed aggregation:contained

nllRegistrationBasis

S C

0..1

ExtensionBinding

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis

Short description

PAPER | PHONE

Alternate names

extensions, user content

Definition

Original format of the prescription. Only used for validation. Input only. For a detached dispense the allowed values are PAPER or PHONE.

Comments

Data type

Binding

registration-basis (required)

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

nllRegistrationBasis

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueCode

There are no (further) constraints on this element

Data type

nllCountryCode

S C

0..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode

Short description

Deprecated. Country code

Alternate names

extensions, user content

Definition

NB! Deprecated, Practitioner.address.country should be used.

Country code, as defined on the authorizing prescription ISO 3166-1 alpha-2 Example: NO (Norway)

Comments

Maximum string length: 2

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

nllCountryCode

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueCode

There are no (further) constraints on this element

Data type

nllSubstitutionAllowed

S C

0..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed

Short description

Indicates if medication may be substituted

Alternate names

extensions, user content

Definition

Indicates if medication may be substituted (sv: generisk substitution tillåten) Only used for validation (input only).

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

nllSubstitutionAllowed

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueBoolean

There are no (further) constraints on this element

Data type

nllFirstDispenseBefore

S C

0..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore

Short description

First dispense must occur before

Alternate names

extensions, user content

Definition

Not 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).

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

nllFirstDispenseBefore

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueDate

There are no (further) constraints on this element

Data type

nllPrescriberCostCenter

S C

0..1

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter

Short description

The prescribers cost center

Alternate names

extensions, user content

Definition

The prescribers cost center code when making the prescription. Used for benefit billing within the regions.

Comments

Minimum string length: 3 Maximum string length: 13

Data type

Constraints

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)

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

nllPrescriberCostCenter

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueIdentifier

There are no (further) constraints on this element

Data type

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

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.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

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

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].type

Short description

Description of identifier

Definition

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

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.

Data type

Identifier Type Codes (extensible)

Binding

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

Constraints

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

system

S Σ

0..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].system

Short description

Cost center (sv arbetsplatskod)

Definition

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.

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.

Data type

Constraints

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

Auto value

http://electronichealth.se/identifier/arbetsplatskod

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].value

Short description

Cost center (sv arbetsplatskod) value

Definition

The 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.

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.

Data type

Constraints

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

Examples
General

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

period

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

assigner

0..1

Reference(Organization)

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Reference(Organization)

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting

Auto value

http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllPrescriptionDetails.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

nllDispenseCrediting

S C

0..1

Extension(Complex)

Element id

MedicationDispense.extension:nllDispenseCrediting

Short description

Crediting details

Alternate names

extensions, user content

Definition

Crediting details for a dispense. Only used when crediting a dispense.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

2..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

creditDate

S C

1..1

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate

Short description

Credit date

Alternate names

extensions, user content

Definition

The date when the dispense was credited.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

creditDate

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueDateTime

There are no (further) constraints on this element

Data type

creditDispatchId

S C

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId

Short description

Credit dispatch id

Alternate names

extensions, user content

Definition

The id of the crediting dispatch.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

creditDispatchId

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueString

There are no (further) constraints on this element

Data type

creditDispatchRowNo

S C

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo

Short description

Credit dispatch row number

Alternate names

extensions, user content

Definition

NB! New attribute planned in release 21.9. Display only. The row number of the crediting dispatch. Identifier for a dispense within a credited dispatch. The crediting row number is submitted in the attribute 'MedicationDispense.extension:nllDispatchRowNo', but will be displayed in 'creditDispatchRowNo'.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

creditDispatchRowNo

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

canonical()

There are no (further) constraints on this element

Data type

canonical()

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueString

There are no (further) constraints on this element

Data type

valueTime

time

There are no (further) constraints on this element

Data type

time

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

There are no (further) constraints on this element

Data type

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

Reference()

There are no (further) constraints on this element

Data type

Reference()

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

MedicationDispense.extension:nllDispenseCrediting.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

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

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

Data type

Constraints

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

identifier

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.identifier

Short description

External identifier

Definition

Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

Comments

This is a business identifier, not a resource identifier.

Data type

Constraints

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

partOf

0..*

Reference(Procedure)

There are no (further) constraints on this element

Element id

MedicationDispense.partOf

Short description

Event that dispense is part of

Definition

The procedure that trigger the dispense.

Data type

Reference(Procedure)

Constraints

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]

status

S Σ ?!

1..1

codeBinding

Element id

MedicationDispense.status

Short description

cancelled | completed

Definition

Note! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat).

Comments

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

Data type

medication-dispense-status (required)

Binding

A coded concept specifying the state of the dispense event.

Constraints

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

statusReason[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.statusReason[x]

Short description

Why a dispense was not performed

Definition

Indicates the reason why a dispense was not performed.

Binding

A code describing why a dispense was not performed.

MedicationDispense Status Reason Codes (example)

Constraints

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

statusReasonCodeableConcept

There are no (further) constraints on this element

Data type

statusReasonReference

Reference(DetectedIssue)

There are no (further) constraints on this element

Data type

Reference(DetectedIssue)

category

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

MedicationDispense.category

Short description

Type of medication dispense

Definition

Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

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.

Data type

MedicationDispense Category Codes (preferred)

Binding

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

Constraints

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

medication[x]

S Σ

1..1

Binding

Element id

MedicationDispense.medication[x]

Short description

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

Comments

Binding

Swedish medicine packages and reimbursed consumables.

http://electronichealth.se/fhir/ValueSet/medicines-consumables (required)

Constraints

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

medicationCodeableConcept

Data type

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

coding

S Σ

1..*

Element id

MedicationDispense.medication[x].coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

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.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

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

nplid

S Σ

0..1

Element id

MedicationDispense.medication[x].coding:nplid

Short description

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)

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplid.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplid.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

system

S Σ

1..1

uriAuto Value

Element id

MedicationDispense.medication[x].coding:nplid.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Auto value

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplid.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

code

S Σ

1..1

Element id

MedicationDispense.medication[x].coding:nplid.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Data type

Constraints

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

display

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplid.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Data type

Constraints

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

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplid.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Constraints

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 ]

nplpackid

S Σ

0..1

Element id

MedicationDispense.medication[x].coding:nplpackid

Short description

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)

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplpackid.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplpackid.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

system

S Σ

1..1

uriAuto Value

Element id

MedicationDispense.medication[x].coding:nplpackid.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Auto value

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplpackid.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

code

S Σ

1..1

Element id

MedicationDispense.medication[x].coding:nplpackid.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Data type

Constraints

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

display

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplpackid.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Data type

Constraints

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

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:nplpackid.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Constraints

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 ]

varunr

S Σ

0..1

Element id

MedicationDispense.medication[x].coding:varunr

Short description

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) Also a non-unique identifier of a medical product package.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:varunr.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:varunr.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

system

S Σ

1..1

uriAuto Value

Element id

MedicationDispense.medication[x].coding:varunr.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Auto value

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:varunr.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

code

S Σ

1..1

Element id

MedicationDispense.medication[x].coding:varunr.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Minimum string length: 6 Maximum string length: 6

Data type

Constraints

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

display

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:varunr.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Data type

Constraints

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

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].coding:varunr.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Constraints

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 ]

text

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.medication[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

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.

Data type

Constraints

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

subject

S Σ

1..1

Reference(NLLPatient)

Element id

MedicationDispense.subject

Short description

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.

Comments

SubstanceAdministration->subject->Patient.

Data type

Reference(NLLPatient)

Allowed aggregation:contained, referenced

Constraints

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

context

0..1

Reference(Encounter | EpisodeOfCare)

There are no (further) constraints on this element

Element id

MedicationDispense.context

Short description

Encounter / Episode associated with event

Definition

The encounter or episode of care that establishes the context for this event.

Data type

Reference(Encounter | EpisodeOfCare)

Constraints

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"]

supportingInformation

0..*

Reference(Resource)

There are no (further) constraints on this element

Element id

MedicationDispense.supportingInformation

Short description

Information that supports the dispensing of the medication

Definition

Additional information that supports the medication being dispensed.

Data type

Reference(Resource)

Constraints

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)]

performer

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.performer

Short description

Who performed event

Definition

Indicates who or what performed the event.

Data type

Constraints

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]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.performer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.performer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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

function

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.performer.function

Short description

Who performed the dispense and what they did

Definition

Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

Requirements

Allows disambiguation of the types of involvement of different performers.

Data type

MedicationDispense Performer Function Codes (example)

Binding

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

Constraints

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

Mappings

rim: participation[typeCode=PRF].functionCode

actor

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.performer.actor

Short description

Individual who was performing

Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

Data type

Constraints

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

Mappings

workflow: Event.performer.actor
rim: .role

location

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.location

Short description

Where the dispense occurred

Definition

The principal physical location where the dispense was performed.

Data type

Reference(MedicationRequest)

Constraints

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

Mappings

rim: .participation[typeCode=LOC].role

authorizingPrescription

0..0

Element id

MedicationDispense.authorizingPrescription

Short description

Medication order that authorizes the dispense

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)

Comments

Maps to basedOn in Event logical model.

Data type

Reference(MedicationRequest)

Constraints

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

type

1..1

CodeableConceptBinding

Element id

MedicationDispense.type

Short description

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). 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.

Data type

Binding

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

dispense-types (required)

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

coding

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

system

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

version

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

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

display

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Data type

Constraints

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

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Constraints

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 ]

text

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

quantity

0..1

Element id

MedicationDispense.quantity

Short description

Amount dispensed

Definition

The amount of medication that has been dispensed. Includes unit of measure.

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

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).

Data type

Constraints

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

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

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

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Constraints

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

unit

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Data type

Constraints

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

system

Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: qty-3

Constraints

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

code

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.quantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

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.

Data type

Constraints

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

daysSupply

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.daysSupply

Short description

Amount of medication expressed as a timing amount

Definition

The amount of medication expressed as a timing amount.

Data type

Constraints

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

whenPrepared

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.whenPrepared

Short description

When product was packaged and reviewed

Definition

The time when the dispensed product was packaged and reviewed.

Data type

Constraints

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

whenHandedOver

1..1

Element id

MedicationDispense.whenHandedOver

Short description

When product was given out

Definition

The time the dispensed product was provided to the patient or their representative.

Data type

Constraints

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

destination

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.destination

Short description

Where the medication was sent

Definition

Identification of the facility/location where the medication was shipped to, as part of the dispense event.

Data type

Constraints

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

receiver

0..*

Reference(Patient | Practitioner)

There are no (further) constraints on this element

Element id

MedicationDispense.receiver

Short description

Who collected the medication

Definition

Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

Data type

Reference(Patient | Practitioner)

Constraints

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

note

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.note

Short description

Information about the dispense

Definition

Extra information about the dispense that could not be conveyed in the other attributes.

Data type

Constraints

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]

dosageInstruction

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction

Short description

How the medication is to be used by the patient or administered by the caregiver

Definition

Indicates how the medication is to be used by the patient.

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.

Data type

Constraints

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]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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

sequence

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.sequence

Short description

The order of the dosage instructions

Definition

Indicates the order in which the dosage instructions should be applied or interpreted.

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.

Data type

Constraints

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

Mappings

v2: TQ1-1
rim: .text

text

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.text

Short description

Free text dosage instructions e.g. SIG

Definition

Free text dosage instructions e.g. SIG.

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.

Data type

Constraints

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

additionalInstruction

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.additionalInstruction

Short description

Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"

Definition

Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

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.

Data type

SNOMEDCTAdditionalDosageInstructions (example)

Binding

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

Constraints

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

Mappings

v2: RXO-7
rim: .text

patientInstruction

S Σ

1..1

Element id

MedicationDispense.dosageInstruction.patientInstruction

Short description

Patient or consumer oriented instructions

Definition

Instructions in terms that are understood by the patient or consumer.

Comments

Maximum string length: 1016

Data type

Constraints

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

timing

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.timing

Short description

When medication should be administered

Definition

When medication should be administered.

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.

Data type

SNOMEDCTMedicationAsNeededReasonCodes (example)

Constraints

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

Mappings

rim: .effectiveTime

asNeeded[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.asNeeded[x]

Short description

Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

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".

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.

Constraints

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

asNeededBoolean

There are no (further) constraints on this element

Data type

asNeededCodeableConcept

There are no (further) constraints on this element

Data type

site

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.site

Short description

Body site to administer to

Definition

Body site to administer to.

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.

Data type

SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)

Binding

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

Constraints

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

Mappings

v2: RXR-2
rim: .approachSiteCode

route

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.route

Short description

How drug should enter body

Definition

How drug should enter body.

Requirements

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

Data type

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)

Constraints

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

Mappings

v2: RXR-1
rim: .routeCode

method

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.method

Short description

Technique for administering medication

Definition

Technique for administering medication.

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.

Data type

SNOMEDCTAdministrationMethodCodes (example)

Binding

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

Constraints

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

Mappings

v2: RXR-4
rim: .doseQuantity

doseAndRate

0..*

Element

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate

Short description

Amount of medication administered

Definition

The amount of medication administered.

Data type

Element

Constraints

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

Mappings

v2: TQ1-2

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

type

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate.type

Short description

The kind of dose or rate specified

Definition

The kind of dose or rate specified, for example, ordered or calculated.

Requirements

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

Data type

Binding

The kind of dose or rate specified.

DoseAndRateType (example)

Constraints

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

Mappings

v2: RXO-21; RXE-23

dose[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate.dose[x]

Short description

Amount of medication per dose

Definition

Amount of medication per dose.

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.

Constraints

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

doseRange

There are no (further) constraints on this element

Data type

doseQuantity

There are no (further) constraints on this element

Data type

rate[x]

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.doseAndRate.rate[x]

Short description

Amount of medication per unit of time

Definition

Amount of medication per unit of time.

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.

Constraints

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

rateRatio

There are no (further) constraints on this element

Data type

rateRange

There are no (further) constraints on this element

Data type

rateQuantity

There are no (further) constraints on this element

Data type

maxDosePerPeriod

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.maxDosePerPeriod

Short description

Upper limit on medication per unit of time

Definition

Upper limit on medication per unit of time.

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".

Data type

Constraints

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

maxDosePerAdministration

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.maxDosePerAdministration

Short description

Upper limit on medication per administration

Definition

Upper limit on medication per administration.

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.

Data type

Constraints

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

Mappings

rim: not supported

maxDosePerLifetime

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.dosageInstruction.maxDosePerLifetime

Short description

Upper limit on medication per lifetime of the patient

Definition

Upper limit on medication per lifetime of the patient.

Requirements

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

Data type

Constraints

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

Mappings

rim: not supported

substitution

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.substitution

Short description

Whether a substitution was performed on the dispense

Definition

Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

Data type

Constraints

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

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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

wasSubstituted

1..1

Element id

MedicationDispense.substitution.wasSubstituted

Short description

Whether a substitution was or was not performed on the dispense

Definition

True if the dispenser dispensed a different drug or product from what was prescribed. Only used for validation (input only).

Data type

Constraints

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

Mappings

rim: .actionNegationInd
EHM: Generikautbyte utfört

type

0..1

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.type

Short description

Code signifying whether a different drug was dispensed from what was prescribed

Definition

A code signifying whether a different drug was dispensed from what was prescribed.

Data type

v3.ActSubstanceAdminSubstitutionCode (example)

Binding

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

Constraints

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

reason

0..*

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.reason

Short description

Why was substitution made

Definition

Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

Data type

v3.SubstanceAdminSubstitutionReason (example)

Binding

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

Constraints

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

responsibleParty

0..*

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MedicationDispense.substitution.responsibleParty

Short description

Who is responsible for the substitution

Definition

The person or organization that has primary responsibility for the substitution.

Data type

Reference(Practitioner | PractitionerRole)

Constraints

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

detectedIssue

0..*

Reference(NLLDetectedIssue)

Element id

MedicationDispense.detectedIssue

Short description

Automatic Format and Constitution Control warning (AFF varning)

Alternate names

Contraindication, Drug Utilization Review (DUR), Alert

Definition

FOR 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.

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.

Data type

Reference(NLLDetectedIssue)

Allowed aggregation:contained

Constraints

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

eventHistory

0..*

Reference(Provenance)

There are no (further) constraints on this element

Element id

MedicationDispense.eventHistory

Short description

A list of relevant lifecycle events

Definition

A summary of the events of interest that have occurred, such as when the dispense was verified.

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.).

Data type

Reference(Provenance)

Constraints

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]

MedicationDispense

Short A medication dispense to a specific patient authorzied by a paper prescription

Definition

Cardinality 0..*

Constraints

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

Short Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1

Must Support True

Summary True

Comments

Mappings

EHM: Logiskt id för uttag pappersrecept

MedicationDispense.meta

Short Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality 0..1

Must Support True

Summary True

Constraints

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

MedicationDispense.meta.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.meta.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1

Must Support True

Summary True

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Constraints

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

Short When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Cardinality 0..1

Summary True

Comments

Constraints

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

MedicationDispense.meta.source

Short Identifies where the resource comes from

Definition

Cardinality 0..1

Summary True

Comments

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.

Constraints

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

MedicationDispense.meta.profile

Short Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality 0..*

Type canonical(StructureDefinition)

Summary True

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Constraints

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

MedicationDispense.meta.security

Short Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..*

Security Labels from the Healthcare Privacy and Security Classification System.

security-labels (extensible)

Must Support True

Summary True

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Constraints

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

MedicationDispense.meta.security.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.meta.security.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 0..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

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

Short Version of the system - if relevant

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Constraints

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

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 0..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Constraints

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

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

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

Short Tags applied to this resource

Definition

Cardinality 0..*

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

CommonTags (example)

Summary True

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Constraints

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

MedicationDispense.implicitRules

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Modifier True

Summary True

Comments

Constraints

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

MedicationDispense.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Comments

Constraints

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

MedicationDispense.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Narrative

Alias narrative, html, xhtml, display

Comments

Constraints

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

Mappings

rim: Act.text?

MedicationDispense.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Mappings

rim: N/A

MedicationDispense.extension

Short Additional content defined by implementations

Definition

Cardinality 1..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Constraints

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

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. May be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency .

Cardinality 0..1

Type Extension(string)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Number of packages dspensed

Definition

Number of packages dspensed

Cardinality 0..1

Type Extension(positiveInt)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

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.

Cardinality 0..1

Type Extension(string)

Must Support True

Alias extensions, user content

Comments

Maximum string length: 12

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Identier for MedicationDispense within dispatch

Definition

Cardinality 0..1

Type Extension(decimal)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Benefit choice

Definition

Type of benefit for the dispense. Only used for validation (input only).

Cardinality 0..1

Type Extension(code)

benefit-choices (required)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Information from the authorizing prescription

Definition

Information from the authorizing prescription

Cardinality 1..1

Type Extension(Complex)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension

Short Additional content defined by implementations

Definition

Cardinality 1..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Date when prescription was initially authored

Definition

Date when prescription was initially authored. Only used for validation (input only).

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllPrescriptionDate

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 1..1

Constraints

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

Short Prescriber

Definition

The prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile).

Cardinality 1..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllPrescriber

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 1..1

Type Reference(NLLPractitioner)

Constraints

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

Short PAPER | PHONE

Definition

Original format of the prescription. Only used for validation. Input only. For a detached dispense the allowed values are PAPER or PHONE.

Cardinality 0..1

registration-basis (required)

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllRegistrationBasis

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 1..1

Constraints

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

Short Deprecated. Country code

Definition

NB! Deprecated, Practitioner.address.country should be used.

Country code, as defined on the authorizing prescription ISO 3166-1 alpha-2 Example: NO (Norway)

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Maximum string length: 2

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllCountryCode

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Constraints

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

Short Indicates if medication may be substituted

Definition

Indicates if medication may be substituted (sv: generisk substitution tillåten) Only used for validation (input only).

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllSubstitutionAllowed

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Constraints

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

Short First dispense must occur before

Definition

Not 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).

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllFirstDispenseBefore

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Constraints

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

Short The prescribers cost center

Definition

The prescribers cost center code when making the prescription. Used for benefit billing within the regions.

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Minimum string length: 3 Maximum string length: 13

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

nllPrescriberCostCenter

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

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.

Constraints

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

Short Description of identifier

Definition

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

Cardinality 0..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

Constraints

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

Short Cost center (sv arbetsplatskod)

Definition

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.

Cardinality 0..1

Must Support True

Summary True

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.

Constraints

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

Auto Value

http://electronichealth.se/identifier/arbetsplatskod

Examples

General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter.value[x].value

Short Cost center (sv arbetsplatskod) value

Definition

The 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.

Cardinality 1..1

Must Support True

Summary True

Comments

Constraints

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

Examples

General

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

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Constraints

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

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

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.

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails

Mappings

rim: N/A

MedicationDispense.extension:nllPrescriptionDetails.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..0

Type base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Constraints

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

Mappings

rim: N/A

MedicationDispense.extension:nllDispenseCrediting

Short Crediting details

Definition

Crediting details for a dispense. Only used when crediting a dispense.

Cardinality 0..1

Type Extension(Complex)

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllDispenseCrediting.extension

Short Additional content defined by implementations

Definition

Cardinality 2..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Credit date

Definition

The date when the dispense was credited.

Cardinality 1..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

creditDate

Mappings

rim: N/A

MedicationDispense.extension:nllDispenseCrediting.extension:creditDate.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 1..1

Constraints

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

Short Credit dispatch id

Definition

The id of the crediting dispatch.

Cardinality 1..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

creditDispatchId

Mappings

rim: N/A

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 1..1

Constraints

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

Short Credit dispatch row number

Definition

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

creditDispatchRowNo

Mappings

rim: N/A

MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Constraints

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

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Auto Value

http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting

Mappings

rim: N/A

MedicationDispense.extension:nllDispenseCrediting.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..0

Constraints

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

Mappings

rim: N/A

MedicationDispense.modifierExtension

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Alias extensions, user content

Requirements

Comments

Constraints

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

Short External identifier

Definition

Cardinality 0..*

Comments

This is a business identifier, not a resource identifier.

Constraints

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

Short Event that dispense is part of

Definition

The procedure that trigger the dispense.

Cardinality 0..*

Type Reference(Procedure)

Constraints

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

Short cancelled | completed

Definition

Note! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat).

Cardinality 1..1

medication-dispense-status (required)

A coded concept specifying the state of the dispense event.

Must Support True

Modifier True

Summary True

Comments

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

Constraints

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]

Short Why a dispense was not performed

Definition

Indicates the reason why a dispense was not performed.

Cardinality 0..1

Type CodeableConcept, Reference(DetectedIssue)

MedicationDispense Status Reason Codes (example)

A code describing why a dispense was not performed.

Constraints

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

Short Type of medication dispense

Definition

Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

Cardinality 0..1

MedicationDispense Category Codes (preferred)

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

Comments

The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

Constraints

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]

Short Dispensed medication

Definition

Cardinality 1..1

http://electronichealth.se/fhir/ValueSet/medicines-consumables (required)

Swedish medicine packages and reimbursed consumables.

Must Support True

Summary True

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.medication[x].extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..*

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Unordered, Open, by system(Value)

Constraints

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

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)

Cardinality 0..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.medication[x].coding:nplid.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

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

Auto 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

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

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

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Constraints

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

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

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

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)

Cardinality 0..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.medication[x].coding:nplpackid.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

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

Auto 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

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

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

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Maximum string length: 14

Constraints

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

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

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

Short Varunummer

Definition

Cardinality 0..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.medication[x].coding:varunr.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

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

Auto 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

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

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

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Minimum string length: 6 Maximum string length: 6

Constraints

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

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

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

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints

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

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.

Cardinality 1..1

Type Reference(NLLPatient)

Must Support True

Summary True

Comments

SubstanceAdministration->subject->Patient.

Constraints

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

Short Encounter / Episode associated with event

Definition

The encounter or episode of care that establishes the context for this event.

Cardinality 0..1

Type Reference(Encounter | EpisodeOfCare)

Constraints

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

Short Information that supports the dispensing of the medication

Definition

Additional information that supports the medication being dispensed.

Cardinality 0..*

Type Reference(Resource)

Constraints

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

Short Who performed event

Definition

Indicates who or what performed the event.

Cardinality 0..*

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.performer.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Constraints

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

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

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

Short Who performed the dispense and what they did

Definition

Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

Cardinality 0..1

MedicationDispense Performer Function Codes (example)

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

Requirements

Allows disambiguation of the types of involvement of different performers.

Constraints

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

Short Individual who was performing

Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

Cardinality 1..1

Constraints

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

Short Where the dispense occurred

Definition

The principal physical location where the dispense was performed.

Cardinality 0..1

Type Reference(Location)

Constraints

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

Short Medication order that authorizes the dispense

Definition

Cardinality 0..0

Type Reference(MedicationRequest)

Comments

Maps to basedOn in Event logical model.

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.authorizingPrescription.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Cardinality 0..0

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

MedicationDispense.authorizingPrescription.type

Short Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Cardinality 0..1

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

ResourceType (extensible)

Summary True

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.

Constraints

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

Mappings

rim: N/A

MedicationDispense.authorizingPrescription.identifier

Short Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Cardinality 0..0

Summary True

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).

Constraints

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

Mappings

rim: .identifier

MedicationDispense.authorizingPrescription.display

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

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.

Constraints

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

Mappings

rim: N/A

MedicationDispense.type

Short Standard packing fill, Dose dispensed fill or Trial fill

Definition

Cardinality 1..1

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

dispense-types (required)

Must Support True

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.type.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.type.coding.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 0..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

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

Short Version of the system - if relevant

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Constraints

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

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Constraints

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

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

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

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints

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

Short Amount dispensed

Definition

The amount of medication that has been dispensed. Includes unit of measure.

Cardinality 0..1

Must Support True

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.quantity.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Cardinality 1..1

Must Support True

Summary True

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Constraints

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

Short < | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Cardinality 0..0

How the Quantity should be understood and represented.

QuantityComparator (required)

Modifier True

Summary True

Requirements

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

Meaning when missing

If there is no comparator, then there is no modification of the value

Constraints

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

Short Unit representation

Definition

A human-readable form of the unit.

Cardinality 0..1

Summary True

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Constraints

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

Short System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Cardinality 0..1

Summary True

Requirements

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

Conditions The cardinality or value of this element may be affected by these constraints: qty-3

Constraints

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

Short Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Cardinality 0..1

Summary True

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Constraints

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

Short Amount of medication expressed as a timing amount

Definition

The amount of medication expressed as a timing amount.

Cardinality 0..1

Constraints

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

Short When product was packaged and reviewed

Definition

The time when the dispensed product was packaged and reviewed.

Cardinality 0..1

Summary True

Constraints

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

Short When product was given out

Definition

The time the dispensed product was provided to the patient or their representative.

Cardinality 1..1

Must Support True

Constraints

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

Short Where the medication was sent

Definition

Identification of the facility/location where the medication was shipped to, as part of the dispense event.

Cardinality 0..1

Type Reference(Location)

Constraints

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

Short Who collected the medication

Definition

Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

Cardinality 0..*

Type Reference(Patient | Practitioner)

Constraints

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

Short Information about the dispense

Definition

Extra information about the dispense that could not be conveyed in the other attributes.

Cardinality 0..*

Constraints

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

Short How the medication is to be used by the patient or administered by the caregiver

Definition

Indicates how the medication is to be used by the patient.

Cardinality 0..1

Must Support True

Comments

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.dosageInstruction.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

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

Short The order of the dosage instructions

Definition

Indicates the order in which the dosage instructions should be applied or interpreted.

Cardinality 0..1

Summary True

Requirements

Constraints

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

Short Free text dosage instructions e.g. SIG

Definition

Free text dosage instructions e.g. SIG.

Cardinality 0..1

Summary True

Requirements

Constraints

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

Short Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"

Definition

Cardinality 0..*

SNOMEDCTAdditionalDosageInstructions (example)

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

Summary True

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.

Constraints

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

Short Patient or consumer oriented instructions

Definition

Instructions in terms that are understood by the patient or consumer.

Cardinality 1..1

Must Support True

Summary True

Comments

Maximum string length: 1016

Constraints

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

Short When medication should be administered

Definition

When medication should be administered.

Cardinality 0..1

Summary True

Requirements

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.

Constraints

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

Mappings

rim: .effectiveTime

MedicationDispense.dosageInstruction.asNeeded[x]

Short Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Cardinality 0..1

Type boolean, CodeableConcept

SNOMEDCTMedicationAsNeededReasonCodes (example)

Summary True

Comments

Constraints

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

Short Body site to administer to

Definition

Body site to administer to.

Cardinality 0..1

SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)

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

Summary True

Requirements

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

Comments

Constraints

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

Short How drug should enter body

Definition

How drug should enter body.

Cardinality 0..1

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)

Summary True

Requirements

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

Constraints

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

Short Technique for administering medication

Definition

Technique for administering medication.

Cardinality 0..1

SNOMEDCTAdministrationMethodCodes (example)

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

Summary True

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.

Constraints

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

Short Amount of medication administered

Definition

The amount of medication administered.

Cardinality 0..*

Element

Summary True

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.dosageInstruction.doseAndRate.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Short The kind of dose or rate specified

Definition

The kind of dose or rate specified, for example, ordered or calculated.

Cardinality 0..1

The kind of dose or rate specified.

DoseAndRateType (example)

Summary True

Requirements

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

Constraints

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]

Short Amount of medication per dose

Definition

Amount of medication per dose.

Cardinality 0..1

Type Range, SimpleQuantity

Summary True

Requirements

The amount of therapeutic or other substance given at one administration event.

Comments

Constraints

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]

Short Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Cardinality 0..1

Type Ratio, Range, SimpleQuantity

Summary True

Requirements

Comments

Constraints

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

Short Upper limit on medication per unit of time

Definition

Upper limit on medication per unit of time.

Cardinality 0..1

Summary True

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

Comments

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".

Constraints

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

Short Upper limit on medication per administration

Definition

Upper limit on medication per administration.

Cardinality 0..1

Summary True

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.

Comments

Constraints

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

Mappings

rim: not supported

MedicationDispense.dosageInstruction.maxDosePerLifetime

Short Upper limit on medication per lifetime of the patient

Definition

Upper limit on medication per lifetime of the patient.

Cardinality 0..1

Summary True

Requirements

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

Constraints

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

Mappings

rim: not supported

MedicationDispense.substitution

Short Whether a substitution was performed on the dispense

Definition

Cardinality 0..1

Must Support True

Constraints

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

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

MedicationDispense.substitution.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Constraints

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

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

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

Short Whether a substitution was or was not performed on the dispense

Definition

True if the dispenser dispensed a different drug or product from what was prescribed. Only used for validation (input only).

Cardinality 1..1

Must Support True

Constraints

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

Short Code signifying whether a different drug was dispensed from what was prescribed

Definition

A code signifying whether a different drug was dispensed from what was prescribed.

Cardinality 0..1

v3.ActSubstanceAdminSubstitutionCode (example)

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

Constraints

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

Short Why was substitution made

Definition

Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

Cardinality 0..*