Page Status: updated 2023-11-22
NLLMedicationListInfo (Basic)
Page index
Introduction
The profile NLLMedicationListInfo is based on the Basic resource. NLLMedicationListInfo provides aggregated information about a patient's medication list e.g. medication list version and a flag telling if a the patient´s medication list contains controlled drugs (sv: särskilda läkemedel).
Overview
| Basic | I | Basic | Element idBasic General information about a medication list Alternate namesZ-resource, Extension-resource, Custom-resource DefinitionThe NLLMedicationListInfo resource contains general information about a patient's medication list.
| |
| id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | S Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBasic.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBasic.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idBasic.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
| lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element idBasic.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBasic.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idBasic.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idBasic.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBasic.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBasic.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idBasic.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idBasic.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | I | 0..* | Extension | Element idBasic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| nllControlledDrugs | S I | 0..1 | Extension(boolean) | Element idBasic.extension:nllControlledDrugs Controlled medicinal products Alternate namesextensions, user content DefinitionThis parameter is set to true if the patient has any medication requests or dispenses for paper prescriptions that contain controlled drugs, which have been prescribed or dispensed within the last 24 months. Note that this information is only available for healthcare personnel authorized to prescribe medicines. 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. http://electronichealth.se/fhir/StructureDefinition/NLLControlledDrugs Constraints
|
| nllMedicationlistVersion | S I | 0..1 | Extension(integer) | Element idBasic.extension:nllMedicationlistVersion Medication list version Alternate namesextensions, user content DefinitionThis attribute provides the version of the patient's medication list. The version is updated when a subset of events (NLLProvenance) affects the patient's medication list. This subset of provenances that impact the list can be found here: <a href="https://samarbetsyta.ehalsomyndigheten.se/handboken/latest/utveckla-mot-e-haelsomyndighetens-tjaenster/information-stoed-och-krav-per-delsystem/nationella-laekemedelslistan-nll/stoed-vid-implementation-nll/informationsspecifikationer/informationsspecifikation-resurser/information-laekemedelslista-nllmedicationlistinfo/">Information läkemedelslista – NLLMedicationListInfo</a> 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. http://electronichealth.se/fhir/StructureDefinition/Version Constraints
|
| nllPrivacyLock | S I | 0..1 | Extension(boolean) | Element idBasic.extension:nllPrivacyLock Privacy lock flag Alternate namesextensions, user content DefinitionThis attribute is set to true if the patient has any MedicationRequests (including all related MedicationDispenses) or dispenses for paper prescriptions that are affected by an NLLDataLock of the type Privacy Lock. This information is only available for healthcare personnel. Note that it doesn't indicate if the locked information is accessible for the user or not, as this depends on the access type used when accessing the patient's medication requests and dispenses. The information provided in the parameter may not be relevant if the selected or presented range of information is not affected by the data lock. The parameter is not available when the access type 'UTAN_KRAV_SAMTYCKE' is used. 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. http://electronichealth.se/fhir/StructureDefinition/NLLPrivacyLock Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idBasic.identifier Business identifier DefinitionIdentifier assigned to the resource for business purposes, outside the context of FHIR.
|
| code | S Σ ?! | 1..1 | CodeableConceptBinding | Element idBasic.code Resource type: Medication List Information DefinitionThe type of resource is "Medication List Information" Must be able to distinguish different types of Basic resources. Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored. Codes for identifying types of Basic
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.code.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | S Σ | 1..1 | Coding | There are no (further) constraints on this element Element idBasic.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.code.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | S Σ | 0..1 | uriFixed Value | Element idBasic.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ehalsomyndigheten.se/fhir/CodeSystem/basic-resource-types
|
| version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | S Σ | 1..1 | codeFixed Value | Element idBasic.code.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
medlistinfo
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. 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. Very often the text is the same as a displayName of one of the codings.
|
| subject | S Σ I | 1..1 | Reference(NLLPatient) | Element idBasic.subject Patient DefinitionIdentifies the patient that the medication list belongs to. Needed for partitioning the resource by Patient. Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
|
| created | Σ | 0..1 | date | There are no (further) constraints on this element Element idBasic.created When created DefinitionIdentifies when the resource was first created. Allows ordering resource instances by time.
|
| author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idBasic.author Who created DefinitionIndicates who was responsible for creating the resource instance. Needed for partitioning the resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Constraints
|
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.
| Element | Description |
|---|---|
| nllControlledDrugs | This parameter is set to true if the patient has any medication requests or dispenses for paper prescriptions that contain controlled drugs, which have been prescribed or dispensed within the last 24 months. Note that this information is only available for healthcare personnel authorized to prescribe medicines. |
| nllPrivacyLock | This attribute is set to true if the patient has any MedicationRequests (including all related MedicationDispenses) or dispenses for paper prescriptions that are affected by an NLLDataLock of the type Privacy Lock. This information is only available for healthcare personnel. Note that it doesn't indicate if the locked information is accessible for the user or not, as this depends on the access type used when accessing the patient's medication requests and dispenses. The information provided in the parameter may not be relevant if the selected or presented range of information is not affected by the data lock. The parameter is not available when the access type 'UTAN_KRAV_SAMTYCKE' is used. |
| nllMedicationlistVersion | This attribute provides the version of the patient's medication list. The version is updated when a subset of events (NLLProvenance) affects the patient's medication list. This subset of provenances that impact the list can be found here: Information läkemedelslista – NLLMedicationListInfo. |
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.
../Basic/[id]../Basic?[parameters]
Parameter chain:
code=medlistinfo
&patient._id=[id]
Compartment searches
Supported searches on a compartment. This kind of search returns a bundle with the related resources.
../Patient/[id]/MedicationListInforeturns all related MedicationListInfo's for the specified patient (in practice, there should only be one).
Include & reverse includes
Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.
../Basic?[parameters]&_revinclude=Provenance:target:Basicreturns one or more Basic resources together with their Provenances. The Provenance returned is the one pointing at the returned version of the Basic resource. See above for a list of valid parameters.
Example: ../Basic?patient._id=<uuid>&code=medlistinfo&_revinclude=Provenance:target:Basic returns the patient's medication listo info including one provenance.
For generic information about how to search in FHIR look here.
Search parameters
The table below shows all supported search parameters.
| Parameter | Description | Comment |
|---|---|---|
| Basic/[id] | A read based on the logical ID (UUID) of a data lock../Basic/<uuid> |
|
| code | Type of resource, mandatory..?code=medlistinfo |
|
| patient._id | Logical id of the patient..&patient._id=<uuid> |