Nationella informationsmängder
0.1 - draft

Nationella informationsmängder - Local Development build (v0.1). See the Directory of published versions

Resource Profile: NLLMedication

Defining URL:https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NLLMedication
Version:0.1
Name:NLLMedication
Status:Active as of 2021-03-30T19:36:18+02:00
Definition:

PLACEHOLDER This resource is used to represent a medicinal product or medical consumables, identified by an npl package id (sv: npl pack id) or product number (sv: varunummer).

Publisher:Socialstyrelsen
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NLLMedication

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Medication

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.identifier is sliced based on the value of value:system

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... nllNPLid S1..1CodingNPL-id
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllNPLid
... nllTradeName S1..1stringName of the medication product
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllTradeName
.... identifier:nplpackid S0..1IdentifierNPL package id
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/nplpackid
.... identifier:varunr S0..1IdentifierBusiness identifier for medicine consumables
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/varunr
... code 0..1CodeableConceptATC Code
.... coding 0..*CodingCode defined by a terminology system
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required)
..... system 0..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
... form S0..1CodeableConceptpowder | tablets | capsule +
... amount S0..1RatioAmount of drug in package

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... nllNPLid S1..1CodingNPL-id
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllNPLid
... nllTradeName S1..1stringName of the medication product
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllTradeName
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*(Slice Definition)Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:nplpackid SΣ0..1IdentifierNPL package id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/nplpackid
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:varunr SΣ0..1IdentifierBusiness identifier for medicine consumables
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/varunr
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... code Σ0..1CodeableConceptATC Code
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount SΣ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... nllNPLid 1..1CodingNPL-id
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllNPLid
... nllTradeName 1..1stringName of the medication product
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllTradeName
... identifier Σ1..*(Slice Definition)Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:nplpackid Σ0..1IdentifierNPL package id
.... identifier:varunr Σ0..1IdentifierBusiness identifier for medicine consumables
... amount Σ0..1RatioAmount of drug in package

doco Documentation for this format

This structure is derived from Medication

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.identifier is sliced based on the value of value:system

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... nllNPLid S1..1CodingNPL-id
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllNPLid
... nllTradeName S1..1stringName of the medication product
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllTradeName
.... identifier:nplpackid S0..1IdentifierNPL package id
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/nplpackid
.... identifier:varunr S0..1IdentifierBusiness identifier for medicine consumables
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/varunr
... code 0..1CodeableConceptATC Code
.... coding 0..*CodingCode defined by a terminology system
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required)
..... system 0..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
... form S0..1CodeableConceptpowder | tablets | capsule +
... amount S0..1RatioAmount of drug in package

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... nllNPLid S1..1CodingNPL-id
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllNPLid
... nllTradeName S1..1stringName of the medication product
URL: https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/nllTradeName
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*(Slice Definition)Business identifier for this medication
Slice: Unordered, Open by value:system
.... identifier:nplpackid SΣ0..1IdentifierNPL package id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/nplpackid
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:varunr SΣ0..1IdentifierBusiness identifier for medicine consumables
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://electronichealth.se/fhir/NamingSystem/varunr
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... code Σ0..1CodeableConceptATC Code
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount SΣ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Medication.identifier:nplpackid.userequiredIdentifierUse
Medication.identifier:nplpackid.typeextensibleIdentifier Type Codes
Medication.identifier:varunr.userequiredIdentifierUse
Medication.identifier:varunr.typeextensibleIdentifier Type Codes
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.codingrequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes

Constraints

IdPathDetailsRequirements
dom-2MedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3MedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4MedicationIf 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-5MedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6MedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Medication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:nplidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:nplidMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:tradenameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:tradenameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.identifier:nplpackid.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.identifier:nplpackid.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:nplpackid.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunrAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.identifier:varunr.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.identifier:varunr.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.identifier:varunr.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.code.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.code.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.formAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.ingredient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.ingredient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.ingredient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.ingredient.item[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredient.isActiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredient.strengthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.batchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.batch.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.batch.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.batch.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.batch.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.batch.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.batch.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())