vkp-MedicationDispense

The full profile documentation is published here: vkp-MedicationDispense-v06

Changes from v05 -> v06

XPath v06 v05
/meta/profile http://ehelse.no/fhir/StructureDefinition/vkp-MedicationDispense-v06 http://ehelse.no/fhir/StructureDefinition/vkp-MedicationDispense-v05
/identifier/system urn:ietf:rfc:3986 [any local namespace]
/category/coding/system http://ehelse.no/fhir/CodeSystem/vkp-medicationdispense-events-v06 http://ehelse.no/fhir/CodeSystem/vkp-medicationdispense-events-v05
/subject/identifier/system urn:oid:2.16.578.1.12.4.1.4.1 http://ehelse.no/fhir/identifiertypes/FNR

Examples

Example Information
Hendelse MedicationDispense example Simple Message Bundle containing notification about a MedicationDispense Event
Hendelse MedicationDispense example with person Simple Message Bundle containing notification about a MedicationDispense Event, includes information about person handling the medication dispense device
Hendelse MedicationDispense Composition Bundle Message Bundle Containing Composition with additional information of the resolution of the MedicationDispense event
Evondos example 1a Evondos use-case 1a
Evondos example 1b Evondos use-case 1b
Evondos example 2a Evondos use-case 2a
Evondos example 2b Evondos use-case 2b
Evondos example 3a Evondos use-case 3a
Evondos example 3b Evondos use-case 3b
Evondos example 3c Evondos use-case 3c
Evondos example 3d Evondos use-case 3d
Evondos example 4 Evondos use-case 4

Overview

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
extension0..*Extension
modifierExtension?!0..*Extension
id0..1string
extension0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uriFixed Value
valueS Σ0..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
partOf0..0Reference(Procedure)
statusΣ ?!0..1codeBinding
id0..1string
extension0..*Extension
codingΣ1..*Coding
textΣ0..1string
id0..1string
extension0..*Extension
codingΣ0..*Coding
textΣ0..1stringFixed Value
id0..1string
extension0..*Extension
referenceΣ C0..0string
id0..1string
extension0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extension0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extension0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
displayS Σ0..1string
context0..0Reference(Encounter | EpisodeOfCare)
supportingInformation0..0Reference(Resource)
id0..1string
extension0..*Extension
modifierExtensionΣ ?!0..*Extension
id0..1string
extension0..*Extension
referenceΣ C0..0string
id0..1string
extension0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
displayΣ0..1string
onBehalfOf0..1Reference(Organization)
authorizingPrescription0..0Reference(MedicationRequest)
type0..0CodeableConcept
quantity0..0SimpleQuantity
daysSupply0..0SimpleQuantity
whenPreparedΣ0..0dateTime
whenHandedOver1..1dateTime
destination0..0Reference(Location)
receiver0..0Reference(Patient | Practitioner)
note0..0Annotation
id0..1string
extension0..*Extension
sequenceΣ0..1integer
textS Σ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
timingΣ0..1Timing
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
siteΣ0..1CodeableConcept
routeΣ0..1CodeableConcept
methodΣ0..1CodeableConcept
doseRangeRange
doseQuantitySimpleQuantity
maxDosePerPeriodΣ0..1Ratio
maxDosePerAdministrationΣ0..1SimpleQuantity
maxDosePerLifetimeΣ0..1SimpleQuantity
rateRatioRatio
rateRangeRange
rateQuantitySimpleQuantity
detectedIssue0..0Reference(DetectedIssue)
notDone0..1boolean
notDoneReasonCodeableConceptCodeableConcept
notDoneReasonReferenceReference(DetectedIssue)
eventHistory0..*Reference(Provenance)

Details

MedicationDispense
ShortDispensing a medication to a named patient
Definition

Profile of the MedicationDispense resource. Used in the Norwegian Personal Connected Health project to document MedicationDispense events from devices dispensing medication to the user at the patients home. The Resource is also used to report that a planned dispense event did not occur according to plan.

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Cardinality0..*
Comments

The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
  • mdd-1: whenHandedOver cannot be before whenPrepared
    whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
  • category-1: When category code is 19 | 20 dosageInstruction.text should be filled out
    category.coding.code = '19'|'20' implies dosageInstruction.text.exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: ..Event
  • rim: Supply[moodCode=EVN]
  • w5: clinical.medication
MedicationDispense.id
ShortLogical 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.

Cardinality0..1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

MedicationDispense.meta
ShortMetadata about the resource
Definition

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

Cardinality0..1
TypeMeta
SummaryTrue
MedicationDispense.implicitRules
ShortA 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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

MedicationDispense.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

Common Languages (extensible)

Binding extensions
maxValueSetAll Languages
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).

MedicationDispense.text
ShortText summary of the resource, for human interpretation
Definition

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

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-1
Mappings
  • rim: Act.text?
MedicationDispense.contained
ShortContained, inline 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.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Mappings
  • rim: N/A
MedicationDispense.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Mappings
  • rim: N/A
MedicationDispense.modifierExtension
ShortExtensions that cannot be ignored
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. Usually modifier elements provide negation or qualification. In order 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.

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Mappings
  • rim: N/A
MedicationDispense.identifier
ShortUnique code or number identifying the MedicationDispense
Definition

Unique code or number identifying the MedicationDispense

VKP project uses UUID.

Example:

"identifier": [
     {
         "system":"urn:ietf:rfc:3986",
         "value":"urn:uuid:a76d9bbf-f293-4fb7-ad4c-2851cac77162"
     }
]
Cardinality0..*
TypeIdentifier
Comments

Should be a UUID

Mappings
  • workflow: …identifier
  • rim: .id
  • w5: id
MedicationDispense.identifier.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.identifier.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.identifier.use
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.identifier.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.identifier.system
ShortThe namespace for UUID
Definition

VKP project uses UUID identifiers, the namespace of UUID is identified by urn:ietf:rfc:3986 Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality0..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Fixed Value
urn:ietf:rfc:3986
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.identifier.value
ShortThe value that is unique
Definition

The actual UUID value. The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.identifier.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

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.partOf
ShortEvent that dispense is part of
Definition

The procedure that the dispense is done because of.

Cardinality0..0
TypeReference(Procedure)
Mappings
  • workflow: …part of
  • rim: .outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]
MedicationDispense.status
Shortin-progress | completed
Definition

A code specifying the state of the set of dispense events.

The VKP project uses a subset of the message-status (http://hl7.org/fhir/medication-admin-status) CodeSystem containing the codes:

  • in-progress
  • completed - Normal reporting of medication dispenced should have status completed
Cardinality0..1
Typecode
Binding

A coded concept specifying the state of the dispense event.

vkp-medicationdispense-message-status-v05.valueset (required)

ModifierTrue
SummaryTrue
Comments

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

Mappings
  • workflow: …status
  • rim: .statusCode
  • w5: status
MedicationDispense.category
ShortEvent types when medication dispencer performs the medication dispense
Definition

Event types when medication dispencer performs the medication dispense. Values from http://ehelse.no/fhir/CodeSystem/vkp-medicationdispense-events-v06 is required

Cardinality1..1
TypeCodeableConcept
Binding

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

vkp-medicationdispense-events-v06.valueset (required)

Mappings
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication dispense"].value
MedicationDispense.category.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.category.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.category.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicationDispense.category.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

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

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.medication[x]:medicationCodeableConcept
ShortWill always be unknown
Definition

VKP project always uses unknown value

Fixed value: "Ukjent medisin"

Cardinality1..1
TypeCodeableConcept
Binding

A coded concept identifying which substance or product can be dispensed

SNOMED CT Medication Codes (example)

SummaryTrue
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  For example if you require form or lot number, then you must reference the Medication resource. .

Fixed Value
{
  "text": "Ukjent medisin"
}
Mappings
  • workflow: …code
  • v2: RXD-2-Dispense/Give Code
  • rim: .participation[typeCode=PRD].role
  • w5: what
MedicationDispense.medication[x]:medicationCodeableConcept.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.medication[x]:medicationCodeableConcept.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.medication[x]:medicationCodeableConcept.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

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]:medicationCodeableConcept.text
ShortVKP always unknown medicine
Definition

VKP expects a fixed value of "Ukjent medisin"

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.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

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

Fixed Value
Ukjent medisin
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
ShortWho the dispense is for
Definition

A link to a resource representing the person or the group to whom the medication will be given.

VKP always references a Patient Resource using a norwegian Fødslesnummer, Felles hjelpenummer or D-nummer in a logical identifier in the subject.identifier element. The Name of the patient should be given in the subject.display element.

Example:

"subject":{
   "identifier":{
      "system":"urn:oid:2.16.578.1.12.4.1.4.1",
      "value":"05073500186"
     },
     "display":"Ærlend Sørgård"
}
Cardinality1..1
TypeReference(Patient | vkp-Patient-v06 | no-basis-Patient)
SummaryTrue
Comments

SubstanceAdministration->subject->Patient.

Mappings
  • workflow: …subject
  • v2: PID-3-Patient ID List
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: who.focus
MedicationDispense.subject.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.subject.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.subject.reference
ShortLiteral 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.

Cardinality0..0
Typestring
SummaryTrue
Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1
Mappings
  • rim: N/A
MedicationDispense.subject.identifier
ShortLogical reference, when literal reference is not known
Definition

VKP expects a FNR for the patient given using system and value elements, as well as the name in the subject.display element.

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.

Cardinality1..1
TypeIdentifier
SummaryTrue
Comments

VKP expects a FNR, DNR or Felles hjelpenummer for the patient that is subject of the medicationdispense. The subject should be identified using system and value elements, as well as the name of the patient in the subject.display element.

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.

Slicing

Unordered, Closed, by system(Value)

Mappings
  • rim: .identifier
MedicationDispense.subject.identifier:FNR
ShortNorwegian FNR
Definition

Fødselsnummer for the patient. Fødselsnummer as one of the possible patient identifier, should at least be sent unless there is a reason not to. Reasons for not sending the Fødselsnummer include but are not limited to, research and apps without a contract for processing data.

Multiple FNR can exist for a person. If several FNR is provided the time period that each identifier is valid should be provided. No information about period is required when only one FNR is provided.

Cardinality0..1
TypeIdentifier
SummaryTrue
AliasFødselsnummer
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.

Mappings
  • rim: .identifier
MedicationDispense.subject.identifier:FNR.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.subject.identifier:FNR.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.subject.identifier:FNR.use
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:FNR.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:FNR.system
ShortIdentification of the Norwegian FNR
Definition

Identifies that this is a Norwegian Fødselsnummer

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Fixed Value
urn:oid:2.16.578.1.12.4.1.4.1
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.subject.identifier:FNR.value
ShortThe actual Fødselsnumme
Definition

The Norwegian Fødselsnummer

Cardinality1..1
Typestring
SummaryTrue
AliasFødselsnummer
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.

ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.subject.identifier:FNR.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.subject.identifier:FNR.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

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.subject.identifier:DNR
ShortThe D-nummer of the patient
Definition

The D-nummer of the patient. (assigned by the norwegian Skatteetaten)

Cardinality0..1
TypeIdentifier
SummaryTrue
AliasD-nummer
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.

Mappings
  • rim: .identifier
MedicationDispense.subject.identifier:DNR.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.subject.identifier:DNR.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.subject.identifier:DNR.use
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:DNR.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:DNR.system
ShortThe identification of the D-nummer
Definition

The identification of the Norwegian D-nummer

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Fixed Value
urn:oid:2.16.578.1.12.4.1.4.2
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.subject.identifier:DNR.value
ShortThe actual D-numme
Definition

The actual Norwegian D-nummer

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.subject.identifier:DNR.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.subject.identifier:DNR.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

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.subject.identifier:FHN
ShortFelles hjelpenummer used for the patient
Definition

Felles hjelpenummer for the patient. Felles hjelpenummer as one of the possible patient identification numbers. The norwegian Felles hjelpenummer shoud only be used when the Fødselsnummer og D-number is unknown.

Cardinality0..1
TypeIdentifier
SummaryTrue
AliasFelles hjelpenummer
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.

Mappings
  • rim: .identifier
MedicationDispense.subject.identifier:FHN.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.subject.identifier:FHN.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.subject.identifier:FHN.use
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:FHN.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.subject.identifier:FHN.system
ShortIdentification of the Norwegian felles hjelpenumme
Definition

Identification of the Norwegian felles hjelpenummer system

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

Fixed Value
urn:oid:2.16.578.1.12.4.1.4.3
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.subject.identifier:FHN.value
ShortThe actual Hjelpenummer
Definition

The actual Norwegian Hjelpenummer

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.subject.identifier:FHN.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.subject.identifier:FHN.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

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.subject.display
ShortText alternative for the resource
Definition

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

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Mappings
  • rim: N/A
MedicationDispense.context
ShortEncounter / Episode associated with event
Definition

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

Cardinality0..0
TypeReference(Encounter | EpisodeOfCare)
Mappings
  • workflow: …context
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]
MedicationDispense.supportingInformation
ShortInformation that supports the dispensing of the medication
Definition

Additional information that supports the medication being dispensed.

Cardinality0..0
TypeReference(Resource)
Mappings
  • 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)]
  • w5: context
MedicationDispense.performer
ShortDevice and person who performed the dispense
Definition

Indicates what device and person that performed the event. It should be assumed that the performer is the dispenser of the medication. The Practitioner handling tthe device can be indicated in addition to the identity of he the device used.

Example:

"performer": [
          {
            "actor": {
              "identifier": {
                "system": "https://fhir.evondos.com/e300-codes/serialnumber",
                "value": "PP000533"
              },
              "display": "Evondos E300 multidosedispenser"
            }
          },
          {
             "actor":{
                "identifier":{
                   "system":"urn:oid:2.16.578.1.12.4.1.4.1",
                   "value":"04056600324"
                  },
               "display":"Magnar Koman"
            }
          }
      ]
Cardinality1..*
TypeBackboneElement
Comments

The performer will be reviewed as part of STU4.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • workflow: …performer
  • rim: .participation[typeCode=PRF]
MedicationDispense.performer.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.performer.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Mappings
  • rim: n/a
MedicationDispense.performer.modifierExtension
ShortExtensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Mappings
  • rim: N/A
MedicationDispense.performer.actor
ShortThe device used to dispense the medication to the patient. For example, a particular medication dispense device
Definition

The device used to dispense the medication to the patient. For example, a particular medication dispense device

VKP-norway: Should be a logical reference containing the IMEI/serial number of the device. display value should contain the name of the device type.

Example:

"performer": [
                    {
                        "actor":{
                            "identifier":{
                                "system":"http://dignio.no/IMEInummer",
                                "value":"123456789101112"
                            },
                            "display":"Medido multidosesdispenser"
                        }
                    }
                ]
Cardinality1..1
TypeReference(Practitioner | Organization | Patient | Device | RelatedPerson)
Mappings
  • workflow: ….actor
  • rim: .role
MedicationDispense.performer.actor.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.performer.actor.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.performer.actor.reference
ShortLiteral 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.

Cardinality0..0
Typestring
SummaryTrue
Comments

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

ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1
Mappings
  • rim: N/A
MedicationDispense.performer.actor.identifier
ShortLogical reference to the medication dispenser/person/organization
Definition

Logical reference to the medication dispenser VKP-norway: Should be a logical reference containing the IMEI/serial number of the device. display value should contain the name of the device type. VKP uses serial numbers decided by the manufacturer of the device.

Cardinality1..1
TypeIdentifier
SummaryTrue
Comments

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

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

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

Mappings
  • rim: .identifier
MedicationDispense.performer.actor.identifier.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.performer.actor.identifier.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.performer.actor.identifier.use
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Mappings
  • v2: N/A
  • rim: Role.code or implied by context
MedicationDispense.performer.actor.identifier.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
MedicationDispense.performer.actor.identifier.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

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

ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicationDispense.performer.actor.identifier.value
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicationDispense.performer.actor.identifier.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicationDispense.performer.actor.identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

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.performer.actor.display
ShortText alternative for the resource
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Comments

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

Mappings
  • rim: N/A
MedicationDispense.performer.onBehalfOf
ShortOrganization organization was acting for
Definition

The organization the device or practitioner was acting on behalf of.

Cardinality0..1
TypeReference(Organization)
Mappings
  • workflow: ….onBehalfOf
  • rim: .role.scopingOrganization
MedicationDispense.authorizingPrescription
ShortMedication order that authorizes the dispense
Definition

Indicates the medication order that is being dispensed against.

Cardinality0..0
TypeReference(MedicationRequest)
Comments

Maps to basedOn in Event logical model.

Mappings
  • workflow: …basedOn
  • v2: ORC-2 Placer Order Number
  • rim: .outboundRelationship[typeCode=FLFS].target[moodCode=RQO]
MedicationDispense.type
ShortTrial fill, partial fill, emergency fill, etc.
Definition

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

Cardinality0..0
TypeCodeableConcept
Binding

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

ActPharmacySupplyType (example)

Mappings
  • v2: RXD-33-Dispense Type
  • rim: .code
MedicationDispense.quantity
ShortAmount dispensed
Definition

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

Cardinality0..0
TypeSimpleQuantity
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
MedicationDispense.daysSupply
ShortAmount of medication expressed as a timing amount
Definition

The amount of medication expressed as a timing amount.

Cardinality0..0
TypeSimpleQuantity
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
ShortWhen product was packaged and reviewed
Definition

The time when the dispensed product was packaged and reviewed.

Cardinality0..0
TypedateTime
SummaryTrue
Mappings
  • v2: RXD-3-Date/Time Dispensed
  • rim: .effectiveTime[xmi:type=IVL_TS].low
MedicationDispense.whenHandedOver
ShortWhen product was given out
Definition

Timestamp defining the point in time the MedicationDispense event took place. The timestamp could also be set for "negative" events, when a product was not provided to the patient according to plan.

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

Example:

"timestamp":"2018-07-18T07:01:06+00:00"
Cardinality1..1
TypedateTime
Mappings
  • workflow: …occurrenceDateTime
  • v2: RXD-3-Date/Time Dispensed
  • rim: .effectiveTime[xmi:type=IVL_TS].high
MedicationDispense.destination
ShortWhere the medication was sent
Definition

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

Cardinality0..0
TypeReference(Location)
Mappings
  • v2: RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address
  • rim: .participation[typeCode=DST].role
MedicationDispense.receiver
ShortWho 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.

Cardinality0..0
TypeReference(Patient | Practitioner)
Mappings
  • rim: .participation[typeCode=RCV].role
MedicationDispense.note
ShortInformation about the dispense
Definition

VKP: In the VPK project additional information about the MedicationDispense event sould be documented in a Composition in the Message Bundle

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

Cardinality0..0
TypeAnnotation
Mappings
  • workflow: …note
  • v2: RXD-9 Dispense Notes
  • rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]
MedicationDispense.dosageInstruction
ShortHow the medication is to be used by the patient or administered by the caregiver
Definition

VKP takes handles information about the dosage given in the text element.

Example text could be: «10 doser medisin ble matet ut for bruk på reise. Første dose: 22/6 kl. 19:00. Siste dose: 24/6 kl. 19:00.»

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

Example code:

"dosageInstruction": [
     {
         "text":"Husk øyedråper!"
     }
]
Cardinality0..*
TypeDosage
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.

Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
MedicationDispense.dosageInstruction.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings
  • rim: n/a
MedicationDispense.dosageInstruction.sequence
ShortThe order of the dosage instructions
Definition

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

Cardinality0..1
Typeinteger
SummaryTrue
Requirements

If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.

Mappings
  • rim: .text
MedicationDispense.dosageInstruction.text
ShortFree text dosage instructions e.g. SIG
Definition

Free text dosage instructions e.g. SIG. from the medication dispenser.

VKP handles information from the medication dispenser given in the text element. Example text: VKP takes handles information about the dosage given in the text element.

Example text could be: «10 doser medisin ble matet ut for bruk på reise. Første dose: 22/6 kl. 19:00. Siste dose: 24/6 kl. 19:00.»

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

Mappings
  • rim: .text
MedicationDispense.dosageInstruction.additionalInstruction
ShortSupplemental instruction - e.g. "with meals"
Definition

Supplemental instruction - e.g. "with meals".

Cardinality0..*
TypeCodeableConcept
Binding

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

SNOMED CT Additional Dosage Instructions (example)

SummaryTrue
Requirements

Additional instruction such as "Swallow with plenty of water" which may or may not be coded.

Mappings
  • rim: .text
MedicationDispense.dosageInstruction.patientInstruction
ShortPatient or consumer oriented instructions
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Mappings
  • rim: .text
MedicationDispense.dosageInstruction.timing
ShortWhen medication should be administered
Definition

When medication should be administered.

Cardinality0..1
TypeTiming
SummaryTrue
Requirements

The timing schedule for giving the medication to the patient. The Schedule 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 may 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.

Mappings
  • rim: .effectiveTime
MedicationDispense.dosageInstruction.asNeeded[x]
ShortTake "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).

Cardinality0..1
Typeboolean, CodeableConcept
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.

SNOMED CT Medication As Needed Reason Codes (example)

SummaryTrue
Comments

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

Mappings
  • rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept
MedicationDispense.dosageInstruction.site
ShortBody site to administer to
Definition

Body site to administer to.

Cardinality0..1
TypeCodeableConcept
Binding

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

SNOMED CT Anatomical Structure for Administration Site Codes (example)

SummaryTrue
Requirements

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

Comments

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

Mappings
  • rim: .approachSiteCode
MedicationDispense.dosageInstruction.route
ShortHow drug should enter body
Definition

How drug should enter body.

Cardinality0..1
TypeCodeableConcept
Binding

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

SNOMED CT Route Codes (example)

SummaryTrue
Requirements

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

Mappings
  • rim: .routeCode
MedicationDispense.dosageInstruction.method
ShortTechnique for administering medication
Definition

Technique for administering medication.

Cardinality0..1
TypeCodeableConcept
Binding

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

SNOMED CT Administration Method Codes (example)

SummaryTrue
Requirements

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

Comments

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

Mappings
  • rim: .doseQuantity
MedicationDispense.dosageInstruction.dose[x]
ShortAmount of medication per dose
Definition

Amount of medication per dose.

Cardinality0..1
TypeRange, SimpleQuantity
SummaryTrue
Requirements

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

Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Mappings
  • rim: .doseQuantity
MedicationDispense.dosageInstruction.maxDosePerPeriod
ShortUpper limit on medication per unit of time
Definition

Upper limit on medication per unit of time.

Cardinality0..1
TypeRatio
SummaryTrue
Requirements

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

Comments

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

Mappings
  • rim: .maxDoseQuantity
MedicationDispense.dosageInstruction.maxDosePerAdministration
ShortUpper limit on medication per administration
Definition

Upper limit on medication per administration.

Cardinality0..1
TypeSimpleQuantity
SummaryTrue
Requirements

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

Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.

Mappings
  • rim: not supported
MedicationDispense.dosageInstruction.maxDosePerLifetime
ShortUpper limit on medication per lifetime of the patient
Definition

Upper limit on medication per lifetime of the patient.

Cardinality0..1
TypeSimpleQuantity
SummaryTrue
Requirements

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

Mappings
  • rim: not supported
MedicationDispense.dosageInstruction.rate[x]
ShortAmount of medication per unit of time
Definition

Amount of medication per unit of time.

Cardinality0..1
TypeRatio, Range, SimpleQuantity
SummaryTrue
Requirements

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

Comments

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

Mappings
  • rim: .rateQuantity
MedicationDispense.substitution
ShortWhether 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.

Cardinality0..0
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]
MedicationDispense.substitution.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicationDispense.substitution.extension
ShortAdditional Content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Mappings
  • rim: n/a
MedicationDispense.substitution.modifierExtension
ShortExtensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Mappings
  • rim: N/A
MedicationDispense.substitution.wasSubstituted
ShortWhether 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.

Cardinality1..1
Typeboolean
Mappings
  • rim: .actionNegationInd
MedicationDispense.substitution.type
ShortCode 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.

Cardinality0..1
TypeCodeableConcept
Binding

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

ActSubstanceAdminSubstitutionCode (example)

Mappings
  • v2: RXO-9-Allow Substitutions / RXE-9-Substitution Status
  • rim: .code
MedicationDispense.substitution.reason
ShortWhy was substitution made
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

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

SubstanceAdminSubstitutionReason (example)

Mappings
  • rim: .reasonCode
MedicationDispense.substitution.responsibleParty
ShortWho is responsible for the substitution
Definition

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

Cardinality0..*
TypeReference(Practitioner)
Mappings
  • rim: .participation[typeCode=PFM].role[classCode=ASSIGN]
MedicationDispense.detectedIssue
ShortClinical issue with action
Definition

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

Cardinality0..0
TypeReference(DetectedIssue)
AliasContraindication, Drug Utilization Review (DUR), Alert
Mappings
  • rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value
MedicationDispense.notDone
ShortWhether the dispense was or was not performed
Definition

True if the dispense was not performed for some reason.

Cardinality0..1
Typeboolean
Mappings
  • workflow: …notDone
  • rim: .actionNegationInd
MedicationDispense.notDoneReason[x]
ShortWhy a dispense was not performed
Definition

Indicates the reason why a dispense was not performed.

Cardinality0..1
TypeReference(DetectedIssue), CodeableConcept
Mappings
  • workflow: …notDoneReason
  • rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="not done reason"].value
MedicationDispense.eventHistory
ShortA list of releveant lifecycle events
Definition

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

Cardinality0..*
TypeReference(Provenance)
Comments

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

Mappings
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]