FHIR IG Statistics: StructureDefinition/profile-medication

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "profile-medication",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-medication",
  "name": "Medication",
  "title": "Medication",
  "status": "draft",
  "description": "Conveys medication details",
  "purpose": "Conveys medication details",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Medication",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Medication.text",
        "path": "Medication.text",
        "max": "0"
      },
      {
        "id": "Medication.code",
        "path": "Medication.code",
        "comment": "Usage Rule - Compounds: To support CPHA backward compatibility, the DIN may be a psedo DIN, or the active DIN/ingredient or the most expensive DIN, or the highest percentage of the compound.   For compounds, description should also be sent as 'text' (medication.code.text) when available.   \r\nUsage Note: This identifies the medication that has been dispensed. A 'code' (Canadian Clinical Drug Data Set (CCDD), or DIN or NPN)  must be provided. A DIN, or an NPN may also be used if a CCDD code is not available.   This has an extensible binding meaning that the CCDD code system should be used but if a code is not available, vendors may also submit a code from the DIN or NPN code system.    Note:  CCDD will encompass all DINs and NPNs.\r\n\r\nCPHA Map:   DIN / GP# / PIN  D.56.03\r\n\r\nDepending 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. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Medication.code.coding",
        "path": "Medication.code.coding",
        "comment": "Usage Note:   Treat as mandatory for all medications.  A code is required or compounds for backwards compatibility.\r\n\r\nCodes 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.",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Medication.code.coding.system",
        "path": "Medication.code.coding.system",
        "comment": "CPHA:  No mapping; this is a new data element\r\n\r\nUsage:  Code systems that are acceptable in the message are:\r\nCCDD - https://fhir.infoway-inforoute.ca/CodeSystem/canadianclinicaldrugdataset\r\nDIN - http://hl7.org/fhir/NamingSystem/ca-hc-din\r\nNPN - http://hl7.org/fhir/NamingSystem/ca-hc-npn\r\nOpinions - PIN - 2.16.840.1.113883.5.1102  (source PEI)\r\nUnlisted Compound - http://pharmacyeclaims.ca/FHIR/CodeSystem/unlisted-compound-codes \r\nAdjudicator-specific Psuedo DINs  - Adjudicator specific.  Each adjudicator will provide the \"Code system\" associated with their set of codes.   Once established this specificaiton can be updated to include\r\n\r\nThe 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.",
        "mustSupport": true
      },
      {
        "id": "Medication.code.coding.code",
        "path": "Medication.code.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Medication.code.text",
        "path": "Medication.code.text",
        "comment": "Usage Note:   Compound names such as \"magic mouthwash\" can be included here.\r\n\r\nVery often the text is the same as a displayName of one of the codings.",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient",
        "path": "Medication.ingredient",
        "comment": "Usage Note:  For testing purposes, the limit is 50 ingredients. \r\nUsage Rule:  UPC /GTIN -->  should be sent if available, together with text, otherwise, just text.\r\nUsage Rule:   support multiple active ingredients\r\nThe 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.",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.extension:IngredientPercentageTotalCost",
        "path": "Medication.ingredient.extension",
        "sliceName": "IngredientPercentageTotalCost",
        "definition": "This represents the percentage of the total cost of the Prescription that this ingredient represents",
        "comment": "Usage Note:   Vendors must include the percentage of cost that each ingredient represents wherever possible.\r\nCPHA Map:   None; new data element",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/ext-ingredient-percentage-total-cost"
            ]
          }
        ],
        "mustSupport": true,
        "isModifier": false
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity",
        "path": "Medication.ingredient.extension",
        "sliceName": "ingredientQuantity",
        "comment": "Usage:   The quantity of an ingredient within the medication.  Must be specified when known\r\nCPHA Map:  None - new data element\r\n\r\nThere 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.",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/ext-IngredientQuantity"
            ]
          }
        ],
        "mustSupport": true,
        "isModifier": false
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity.value[x]",
        "path": "Medication.ingredient.extension.value[x]"
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity.value[x].value",
        "path": "Medication.ingredient.extension.value[x].value",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity.value[x].unit",
        "path": "Medication.ingredient.extension.value[x].unit",
        "mustSupport": false
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity.value[x].system",
        "path": "Medication.ingredient.extension.value[x].system",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.extension:ingredientQuantity.value[x].code",
        "path": "Medication.ingredient.extension.value[x].code",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.item[x]",
        "path": "Medication.ingredient.item[x]",
        "comment": "Usage Note:   All ingredients should be codified where possible.   A textual desciption should be provided when coding is not one of the known accepable codings (eg DIN, CCDD, NPN, etc)\r\nUsage Note:   If an ingredient cannot be codified, text must be provided (eg for non drug related items such as water)",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.item[x].coding",
        "path": "Medication.ingredient.item[x].coding",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.item[x].coding.system",
        "path": "Medication.ingredient.item[x].coding.system",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.item[x].coding.code",
        "path": "Medication.ingredient.item[x].coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.item[x].text",
        "path": "Medication.ingredient.item[x].text",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.isActive",
        "path": "Medication.ingredient.isActive",
        "comment": "Usage Note:  This must be populated when ingredient is active.   More than one active ingredient may be specified.",
        "mustSupport": true
      },
      {
        "id": "Medication.ingredient.strength",
        "path": "Medication.ingredient.strength",
        "comment": "Usage Note:   May be provided if available and applicable\r\nThe Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit.  Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
        "mustSupport": true
      }
    ]
  }
}