SMIS API Guide

SMIS Medication Profile

Logical URI: http://smis.ch/fhir/StructureDefinition/Medication

Base Profile

The profile builds on Medication

Medication	I		http://hl7.org/fhir/StructureDefinition/DomainResource	Element id Medication Short description Definition of a Medication Definition This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication. Data type http://hl7.org/fhir/StructureDefinition/DomainResource 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()` Mappings rim: Entity. Role, or Act script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed rim: ManufacturedProduct[classCode=ADMM] w5: clinical.medication
id	Σ	0..1	id	There are no (further) constraints on this element Element id Medication.id Short description Logical 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. 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. Data type id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Medication.meta Short description Metadata 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. Data type Meta
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Medication.implicitRules Short description A 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. 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. Data type uri
language		0..1	codeBinding	There are no (further) constraints on this element Element id Medication.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. ?? (extensible)
text	I	0..1	Narrative	There are no (further) constraints on this element Element id Medication.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Medication.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained 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. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension		0..*	Extension	There are no (further) constraints on this element Element id Medication.extension Short description Additional Content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings rim: N/A
modifierExtension	?!	0..*	Extension	There are no (further) constraints on this element Element id Medication.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings rim: N/A
code	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id Medication.code Short description Codes that identify this medication Definition A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Comments Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Data type CodeableConcept Binding A coded concept that defines the type of a medication ?? (example) Mappings script10.6: coding.code = //element(,MedicationType)/DrugCoded/ProductCode coding.system = //element(,MedicationType)/DrugCoded/ProductCodeQualifier coding.display = //element(,MedicationType)/DrugDescription v2:* RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code rim: .code w5: class
status	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Medication.status Short description active \| inactive \| entered-in-error Definition A code to indicate if the medication is in active use. Comments This status is not intended to specify if a medication is part of a formulary. Data type code Binding A coded concept defining if the medication is in active use ?? (required) Mappings rim: .statusCode
isBrand	Σ	0..1	boolean	There are no (further) constraints on this element Element id Medication.isBrand Short description True if a brand Definition Set to true if the item is attributable to a specific manufacturer. Data type boolean Mappings script10.6: no mapping rim: true if .player.scopingRole[typeCode=MANU] exists w5: class
isOverTheCounter	Σ	0..1	boolean	There are no (further) constraints on this element Element id Medication.isOverTheCounter Short description True if medication does not require a prescription Definition Set to true if the medication can be obtained without an order from a prescriber. Data type boolean Mappings rim: NA w5: class
manufacturer	Σ	0..1	Reference(http://hl7.org/fhir/StructureDefinition/Organization)	There are no (further) constraints on this element Element id Medication.manufacturer Short description Manufacturer of the item Definition Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. Data type Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings script10.6: no mapping v2: RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name rim: .player.scopingRole[typeCode=MANU].scoper w5: who.actor
form		0..1	CodeableConcept	There are no (further) constraints on this element Element id Medication.form Short description powder \| tablets \| capsule + Definition Describes the form of the item. Powder; tablets; capsule. Comments When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. Data type CodeableConcept Binding A coded concept defining the form of a medication ?? (example) Mappings script10.6: coding.code = //element(,DrugCodedType)/FormCode coding.system = //element(,DrugCodedType)/FormSourceCode v2: RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form rim: .formCode
ingredient		0..*	BackboneElement	There are no (further) constraints on this element Element id Medication.ingredient Short description Active or inactive ingredient Definition Identifies a particular constituent of interest in the product. Comments The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. Data type BackboneElement Mappings rim: .scopesRole[typeCode=INGR]
package		0..1	BackboneElement	There are no (further) constraints on this element Element id Medication.package Short description Details about packaged medications Definition Information that only applies to packages (not products). Data type BackboneElement Mappings script10.6: no mapping rim: .player[classCode=CONT]
image		0..*	Attachment	There are no (further) constraints on this element Element id Medication.image Short description Picture of the medication Definition Photo(s) or graphic representation(s) of the medication. Requirements Note that "image" is only applicable when the medication.code represents a physical item (e.g. Amoxil 250 mg capsule) and not an abstract item (e.g. amoxicillin 250 mg). Data type Attachment Mappings rim: .participation[typeCode=SUBJ].role[classCode=MANU],source[classCode=OBS,moodCode=EVN,code="type of image"].value(ED.image)

Differential table

Medication		http://hl7.org/fhir/StructureDefinition/Medication	There are no (further) constraints on this element Data type http://hl7.org/fhir/StructureDefinition/Medication
code	1..		There are no (further) constraints on this element Element id Medication.code
coding	1..		There are no (further) constraints on this element Element id Medication.code.coding
system	1..	Fixed Value	There are no (further) constraints on this element Element id Medication.code.coding.system Fixed value urn:oid:2.16.756.5.30.2.6.1
code	1..		There are no (further) constraints on this element Element id Medication.code.coding.code
display	1..		There are no (further) constraints on this element Element id Medication.code.coding.display
package	1..		There are no (further) constraints on this element Element id Medication.package
content	1..		There are no (further) constraints on this element Element id Medication.package.content
itemCodeableConcept		CodeableConcept	There are no (further) constraints on this element Element id Medication.package.content.item[x]:itemCodeableConcept Data type CodeableConcept
coding	1..		There are no (further) constraints on this element Element id Medication.package.content.item[x]:itemCodeableConcept.coding
system		Fixed Value	There are no (further) constraints on this element Element id Medication.package.content.item[x]:itemCodeableConcept.coding.system Fixed value http://chmed16af.emediplan.ch/fhir/CodeSystem/chmed16af-codesystem-cdtyp9
code	1..		There are no (further) constraints on this element Element id Medication.package.content.item[x]:itemCodeableConcept.coding.code

Structure Definition

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Medication" />
    <meta>
        <lastUpdated value="2018-09-12T21:11:09.598+00:00" />
    </meta>
    <url value="http://smis.ch/fhir/StructureDefinition/Medication" />
    <version value="1.0" />
    <name value="Medication" />
    <title value="Smis Medication Profile" />
    <status value="draft" />
    <date value="2018-09-12T21:11:09.005+00:00" />
    <publisher value="Arpage AG" />
    <contact>
        <name value="Patrick Husi" />
        <telecom>
            <system value="email" />
            <value value="patrick.husi@arpage.ch" />
        </telecom>
    </contact>
    <description value="Smis Medication Profile" />
    <fhirVersion value="3.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Medication" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" />
    <derivation value="constraint" />
    <differential>
        <element id="Medication.code">
            <path value="Medication.code" />
            <min value="1" />
        </element>
        <element id="Medication.code.coding">
            <path value="Medication.code.coding" />
            <min value="1" />
        </element>
        <element id="Medication.code.coding.system">
            <path value="Medication.code.coding.system" />
            <min value="1" />
            <fixedUri value="urn:oid:2.16.756.5.30.2.6.1" />
        </element>
        <element id="Medication.code.coding.code">
            <path value="Medication.code.coding.code" />
            <min value="1" />
        </element>
        <element id="Medication.code.coding.display">
            <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
                <valueBoolean value="true" />
            </extension>
            <path value="Medication.code.coding.display" />
            <min value="1" />
        </element>
        <element id="Medication.package">
            <path value="Medication.package" />
            <min value="1" />
        </element>
        <element id="Medication.package.content">
            <path value="Medication.package.content" />
            <min value="1" />
        </element>
        <element id="Medication.package.content.item[x]:itemCodeableConcept">
            <path value="Medication.package.content.itemCodeableConcept" />
            <sliceName value="itemCodeableConcept" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="Medication.package.content.item[x]:itemCodeableConcept.coding">
            <path value="Medication.package.content.itemCodeableConcept.coding" />
            <min value="1" />
        </element>
        <element id="Medication.package.content.item[x]:itemCodeableConcept.coding.system">
            <path value="Medication.package.content.itemCodeableConcept.coding.system" />
            <fixedUri value="http://chmed16af.emediplan.ch/fhir/CodeSystem/chmed16af-codesystem-cdtyp9" />
        </element>
        <element id="Medication.package.content.item[x]:itemCodeableConcept.coding.code">
            <path value="Medication.package.content.itemCodeableConcept.coding.code" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>

Medication example

Command 'json' could not render: File was not found for SMIS/Medication-example