{ "resourceType": "StructureDefinition", "meta": { "lastUpdated": "2018-03-07T18:02:56.499+00:00" }, "url": "http://hl7.org/fhir/ips/StructureDefinition/medication-uv-ips", "version": "0.1", "name": "Medication-uv-ips", "title": "Medication", "status": "draft", "experimental": true, "date": "2018-02-20T21:03:08.307+00:00", "publisher": "HL7 International", "contact": [ { "name": "Chritof Gessner" }, { "name": "François Macary" } ], "description": "This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile.", "purpose": "This profile constrains the representation of a medication, in the context of the international patient summary as specified by the IPS project of HL7 International.", "fhirVersion": "3.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication", "path": "Medication", "comment": "IPS Medication" }, { "id": "Medication.code", "path": "Medication.code", "short": "Codes that identify this medication, sliced to support IDMP", "max": "1", "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/ips/StructureDefinition/CodeableConcept-uv-ips" } ], "mustSupport": true }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "description": "This slicing on the coding element of Medication.code is open, with discriminator based on the value of the Coding.system element. It supports both identifiers and categories or classes for representing the medication. \r\nIt carries one slice for each of the IDMP identifiers, plus one slice for the ATC classification. \r\nOther representations of the medication (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. \r\nThe IDMP slices are provisional, and will be usable when the IDMP identifiers become available.", "rules": "open" }, "definition": "A representation of the medication in a code system. The representation can be granular or may also be a class or category." }, { "id": "Medication.code.coding:pharmaceuticalProduct-L1", "path": "Medication.code.coding", "sliceName": "pharmaceuticalProduct-L1", "short": "Pharmaceutical Product Identifier, Level 1", "definition": "IDMP PhPID Level 1 (Implies ingredients) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "max": "1" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L1.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l1" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L1.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:pharmaceuticalProduct-L2", "path": "Medication.code.coding", "sliceName": "pharmaceuticalProduct-L2", "short": "Pharmaceutical Product Identifier, Level 2", "definition": "IDMP PhPID Level 2 (Implies ingredients and strength) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "max": "1" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L2.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l2" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L2.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:pharmaceuticalProduct-L3", "path": "Medication.code.coding", "sliceName": "pharmaceuticalProduct-L3", "short": "Pharmaceutical Product Identifier, Level 3", "definition": "IDMP PhPID Level 3 (Implies ingredients and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "max": "1" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L3.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l3" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L3.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:pharmaceuticalProduct-L4", "path": "Medication.code.coding", "sliceName": "pharmaceuticalProduct-L4", "short": "Pharmaceutical Product Identifier, Level 4", "definition": "IDMP PhPID Level 4 (Implies ingredients, strength, and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "max": "1" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L4.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l4" }, { "id": "Medication.code.coding:pharmaceuticalProduct-L4.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:medicinalProduct", "path": "Medication.code.coding", "sliceName": "medicinalProduct", "short": "Medicinal Product Identifier", "definition": "IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier.\r\n\r\nIDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorisation numbers allocated by a regulator.\r\n\r\nMPID implies one (set of) PhPID.\r\nThe MPID shall use a common segment pattern related to a Medicinal Product, which\r\nwhen each segment is valued shall define a specific MPID concept. The pattern is:\r\n• a) Country code segment (ISO 3166-1 alpha-2 code elements);\r\n• b) Marketing Authorization Holder (Organization Identifier) code segment;\r\n• c) Medicinal Product code segment (Unique Medicinal Product Identifier).\r\n• Any change of the values related to these three code segments shall result in the\r\nassignment of a new MPID.", "max": "1" }, { "id": "Medication.code.coding:medicinalProduct.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/mpid" }, { "id": "Medication.code.coding:medicinalProduct.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:packagedProduct", "path": "Medication.code.coding", "sliceName": "packagedProduct", "short": "Packaged Medicinal Product Identifier", "definition": "IDMP Packaged Medicinal Product Identifier or any equivalent Packaged Medicinal Product Identifier.\r\n\r\nUniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package;\r\n\r\nThe PCID shall use a common segment pattern related to a package of a Medicinal\r\nProduct, which when each segment is valued, shall define a specific PCID concept. The\r\npattern is:\r\n• a) MPID for the Medicinal Product\r\n• b) package description code segment, which refers to a unique identifier for each\r\npackage.", "max": "1" }, { "id": "Medication.code.coding:packagedProduct.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/pcid" }, { "id": "Medication.code.coding:packagedProduct.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.coding:atcClass", "path": "Medication.code.coding", "sliceName": "atcClass", "short": "Product classification or cluster", "definition": "ATC classification for medication product", "max": "1", "binding": { "strength": "extensible", "description": "ATC class for the medication", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/whoatc-uv-ips" } }, { "id": "Medication.code.coding:atcClass.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "http://www.whocc.no/atc" }, { "id": "Medication.code.coding:atcClass.code", "path": "Medication.code.coding.code", "min": 1 }, { "id": "Medication.code.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Medication.code.text", "definition": "This element is supposed to be valorized with the complete Medicinal Product Name as approved by the Medicines Regulatory Agency in a jurisdiction.\r\nThe name may be applicable in one or more country/language combinations.", "mustSupport": true }, { "id": "Medication.status", "path": "Medication.status", "max": "0" }, { "id": "Medication.isBrand", "path": "Medication.isBrand", "max": "0" }, { "id": "Medication.isOverTheCounter", "path": "Medication.isOverTheCounter", "max": "0" }, { "id": "Medication.manufacturer", "path": "Medication.manufacturer", "max": "0" }, { "id": "Medication.form", "path": "Medication.form", "definition": "Describes the form of the item. Powder; tablets; capsule.\r\n\r\nAdministrable Pharmaceutical Dose Form. \r\nThis code represents the form of the medication (e.g. tablet, capsule, liquid)\r\n\r\nSince the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration.\r\n\r\nIt is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.", "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/ips/StructureDefinition/CodeableConcept-uv-ips" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationForm" } ], "strength": "example", "valueSetReference": { "reference": "http://hl7.org/fhir/ips/ValueSet/medicine-doseform" } } }, { "id": "Medication.form.coding.system", "path": "Medication.form.coding.system", "binding": { "strength": "required", "description": "EDQM Standard Terms", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/medicine-doseform" } }, { "id": "Medication.ingredient", "path": "Medication.ingredient", "mustSupport": true }, { "id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept", "path": "Medication.ingredient.itemCodeableConcept", "sliceName": "itemCodeableConcept", "comment": "The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. \r\nThe Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard.\r\nThose identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances.\r\nThis choice will be revised based on the availability and the maturity of GInAS.", "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/ips/StructureDefinition/CodeableConcept-uv-ips" } ], "binding": { "strength": "preferred", "description": "SNOMED CT drug substances", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/medicine-active-substances-uv-ips" } }, { "id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding", "path": "Medication.ingredient.itemCodeableConcept.coding", "mustSupport": true }, { "id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.coding.system", "path": "Medication.ingredient.itemCodeableConcept.coding.system", "binding": { "strength": "preferred", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/medicine-active-substances-uv-ips" } }, { "id": "Medication.ingredient.itemCodeableConcept:itemCodeableConcept.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Medication.ingredient.itemCodeableConcept.text", "mustSupport": true }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "max": "0" }, { "id": "Medication.ingredient.amount", "path": "Medication.ingredient.amount", "type": [ { "code": "Ratio", "profile": "http://hl7.org/fhir/ips/StructureDefinition/Ratio-uv-ips" } ], "mustSupport": true }, { "id": "Medication.package", "path": "Medication.package", "definition": "Removed as pre-adoption of R4.", "max": "0" } ] } }