MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - Medication

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-medication Version: 0.16.0
Active as of 2020-11-06 Computable Name: MNIMedication

Copyright/Legal: novcom AG

MedNet Interface (MNI) - Medication Profile

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN SΣ 0..1 Coding Code defined by the GTIN terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:Pharmacode SΣ 0..1 Coding Code defined by the Pharmacode terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ProductNumber SΣ 0..1 Coding Code defined by the ProductNumber terminology system
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... code S 1..1 CodeableConcept Codes that identify this medication
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN S 0..1 Coding Code defined by the GTIN terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:Pharmacode S 0..1 Coding Code defined by the Pharmacode terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ProductNumber S 0..1 Coding Code defined by the ProductNumber terminology system
...... system S 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... text S 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN SΣ 0..1 Coding Code defined by the GTIN terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:Pharmacode SΣ 0..1 Coding Code defined by the Pharmacode terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ProductNumber SΣ 0..1 Coding Code defined by the ProductNumber terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

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

... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

Summary

Mandatory: 2 elements(5 nested mandatory elements)
Must-Support: 16 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Medication.code.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN SΣ 0..1 Coding Code defined by the GTIN terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:Pharmacode SΣ 0..1 Coding Code defined by the Pharmacode terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ProductNumber SΣ 0..1 Coding Code defined by the ProductNumber terminology system
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... code S 1..1 CodeableConcept Codes that identify this medication
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN S 0..1 Coding Code defined by the GTIN terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:Pharmacode S 0..1 Coding Code defined by the Pharmacode terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ProductNumber S 0..1 Coding Code defined by the ProductNumber terminology system
...... system S 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... text S 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication MedNet Interface (MNI) - Medication
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:GTIN SΣ 0..1 Coding Code defined by the GTIN terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.51.1.1
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:Pharmacode SΣ 0..1 Coding Code defined by the Pharmacode terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.2.6.1
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ProductNumber SΣ 0..1 Coding Code defined by the ProductNumber terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: https://mednet.swiss/fhir/productNumber
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 1..1 string Should contain the full name or label of the medication in the document language. This text must alway be provided
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

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

... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

Summary

Mandatory: 2 elements(5 nested mandatory elements)
Must-Support: 16 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Medication.code.coding

 

Other representations of profile: CSV, Excel, Schematron