Page Status: updated 2022-03-14

Medication

Page index

Introduction

The Medication resource, shown in the profile NLLMedication, is used for the identification and definition of a medicinal product or a medical consumable associated with a MedicationRequest or MedicationDispense. The medication resource is based on data from the VARA registry (a registry provided by the Swedish eHealth Agency).

Overview

idS Σ0..1System.String
statusS1..1codeBindingFixed Value
divS I1..1xhtml
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
valuePeriodPeriod
url1..1System.StringFixed Value
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueS Σ0..1decimal
comparatorΣ ?!0..1codeBinding
unitS Σ0..1string
systemΣ I0..1uri
codeΣ0..1code
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueDatedate
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
valueBooleanboolean
url1..1System.StringFixed Value
url1..1System.StringFixed Value
useS Σ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useS Σ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
statusS Σ ?!0..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ0..1string
codingΣ0..*Coding
textS Σ0..1string
nllDescriptionS I0..1Extension(string)
valueS Σ0..1decimal
comparatorΣ ?!0..1codeBinding
unitS Σ0..1string
systemΣ I0..1uri
codeΣ0..1code
valueS Σ0..1decimal
comparatorΣ ?!0..1codeBinding
unitΣ0..1string
systemΣ I0..1uri
codeΣ0..1code
itemCodeableConceptCodeableConcept
itemReferenceReference(Substance | Medication)
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.

Medication statuses

The available statuses for the medication resource mirror the statuses used by the Swedish Medical Products Agency (sv Läkemedelsverket) and the VARA registry. The following statuses are used within the National Medication List for the medication resource.

Code Definition
active Dispenseable at the pharmacy (sv: möjlig att expediera)
inactive Not dispenseable at the pharmacy (sv: inte möjlig att expediera)
entered-in-error The medication was entered in error (sv: felaktigt registrerad artikel)
This code is not used at the moment but remains in the value set for future use

See Value Set Medication Status Codes.

Medication identifiers

The following business identifiers are used within the National Medication List for medicinal products and medical consumables.

Attribute Definition
nplpackid Unique identifier for a packaged medicinal product (sv: läkemedelsartikel)
varunr Unique identifier for a medical consumable (sv:handelsvara)

Note that nplid is not an unique identifier of a medication resource and therefore not a valid business identifier. A medicinal product can come in more than one package type/size. Each package type/size will have an unique NPL package Id but share the same NPL Id.

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) no
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) no

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported queries

The following query alternatives are available for this resource.

  1. ../Medication/[id]

  2. ../Medication?[parameters]
    Parameter chains:

    Chain 1
    nplPackId=[id]{,[id]...}

    Chain 2
    varunr=[id]{,[id]...}

Compartment searches

Compartments are not supported by this resource.

Include & reverse includes

Include and revinclude are not supported by this resource.

Search parameters

The table below shows all supported search parameters.

Search parameter Description Comment
Medication/[id] A read based on the logical ID (UUID) of a product
../Medication/<uuid>
nplPackId NPL pack-id of a medicinal product
..?nplPackId=19590101100023,20010720100892
varunr Medical consumables Id of a consumables product
..?varunr=185124

Other operations (extensions)

This resource has no extended operations.