FHIR IG Statistics: StructureDefinition/IDMS-ChargeItemDefinition-Rebate-Profile

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "IDMS-ChargeItemDefinition-Rebate-Profile",
  "url": "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-ChargeItemDefinition-RebateDefinition",
  "version": "1.0.0",
  "name": "Rebate_Definition",
  "title": "IDMS - ChargeItemDefinition - Rebate Definition",
  "status": "draft",
  "description": "Rebate definition",
  "fhirVersion": "5.0.0",
  "kind": "resource",
  "abstract": false,
  "type": "ChargeItemDefinition",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "ChargeItemDefinition",
        "path": "ChargeItemDefinition",
        "short": "Rebate Definition and how the price and the applicability of a ChargeItem can be determined",
        "definition": "#### **_`Rebate Defition.  Invoice line items (ChargeItems) are based on rebate definitions (ChargeItemDefinitions)  `_**\r\n\r\nThe ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system."
      },
      {
        "id": "ChargeItemDefinition.url",
        "path": "ChargeItemDefinition.url",
        "definition": "#### **_`Unique URI for the rebate definition. This is referenced by the invoice line item (ChargeItem)  `_**\r\n\r\nAn absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.identifier",
        "path": "ChargeItemDefinition.identifier",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.versionAlgorithm[x]",
        "path": "ChargeItemDefinition.versionAlgorithm[x]",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.name",
        "path": "ChargeItemDefinition.name",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.title",
        "path": "ChargeItemDefinition.title",
        "short": "Rebate Name",
        "definition": "#### **_`Name given to the rebate by the manufacturer. Can appear on the invoice that is sent to manufacturer.`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.derivedFromUri",
        "path": "ChargeItemDefinition.derivedFromUri",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.partOf",
        "path": "ChargeItemDefinition.partOf",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.replaces",
        "path": "ChargeItemDefinition.replaces",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.status",
        "path": "ChargeItemDefinition.status",
        "definition": "#### **_`Status of the Rebate. Examples:  Inactive, Active, Hypothetical Rebate (Conditions need to be met before active).  Only FHIR statuses can be used so there needs to be a mapping.  Mapping: draft=Inactive, active=Active, unknown=Hypothetical.  A valueSet will be created to help with the mapping`_**"
      },
      {
        "id": "ChargeItemDefinition.experimental",
        "path": "ChargeItemDefinition.experimental",
        "short": "Manual Calculation Indicator",
        "definition": "#### **_`Indicates the rebate calculation is manual instead of automatic.  True = Manual,  False = Automatic`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.date",
        "path": "ChargeItemDefinition.date",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.publisher",
        "path": "ChargeItemDefinition.publisher",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.contact",
        "path": "ChargeItemDefinition.contact",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.description",
        "path": "ChargeItemDefinition.description",
        "short": "Working Notes",
        "definition": "#### **_`Working notes on this rebate, including details about what will happen on the renegotion date..`_**"
      },
      {
        "id": "ChargeItemDefinition.useContext",
        "path": "ChargeItemDefinition.useContext",
        "short": "Billing Frequency",
        "definition": "#### **_`Billing frequency for this rebate.  Examples: Quarterly, Annual, etc..`_**\r\n\r\n\r\nThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ChargeItemDefinition.useContext.code",
        "path": "ChargeItemDefinition.useContext.code",
        "short": "Context Type",
        "definition": "#### **_`FHIR Mandatory so just populate the display with Billing Frequency `_**\r\n\r\nA code that identifies the type of context being specified by this usage context."
      },
      {
        "id": "ChargeItemDefinition.useContext.code.system",
        "path": "ChargeItemDefinition.useContext.code.system",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.code.version",
        "path": "ChargeItemDefinition.useContext.code.version",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.code.code",
        "path": "ChargeItemDefinition.useContext.code.code",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.code.display",
        "path": "ChargeItemDefinition.useContext.code.display",
        "definition": "#### **_`FHIR Mandatory so always populate with \"Billing Frequency\"`_**",
        "fixedString": "Billing Frequency"
      },
      {
        "id": "ChargeItemDefinition.useContext.code.userSelected",
        "path": "ChargeItemDefinition.useContext.code.userSelected",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x]",
        "path": "ChargeItemDefinition.useContext.value[x]",
        "definition": "#### **_`Billing Frequency code and display value`_**",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding",
        "path": "ChargeItemDefinition.useContext.value[x].coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding.system",
        "path": "ChargeItemDefinition.useContext.value[x].coding.system",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding.version",
        "path": "ChargeItemDefinition.useContext.value[x].coding.version",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding.code",
        "path": "ChargeItemDefinition.useContext.value[x].coding.code",
        "short": "Billing Frequency Code",
        "definition": "#### **_`Billing Frequency code`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding.display",
        "path": "ChargeItemDefinition.useContext.value[x].coding.display",
        "short": "Billing Frequency",
        "definition": "#### **_`Billing Frequency display value`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].coding.userSelected",
        "path": "ChargeItemDefinition.useContext.value[x].coding.userSelected",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.useContext.value[x].text",
        "path": "ChargeItemDefinition.useContext.value[x].text",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.jurisdiction",
        "path": "ChargeItemDefinition.jurisdiction",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.purpose",
        "path": "ChargeItemDefinition.purpose",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.copyright",
        "path": "ChargeItemDefinition.copyright",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.copyrightLabel",
        "path": "ChargeItemDefinition.copyrightLabel",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.approvalDate",
        "path": "ChargeItemDefinition.approvalDate",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.lastReviewDate",
        "path": "ChargeItemDefinition.lastReviewDate",
        "short": "Renegotiation date",
        "definition": "#### **_`Some rebates have the option for renegotiation at the end of the contract and if no agreement is reached, previous rebate details are retained. In these cases, the renegotiation date will still be entered.`_**"
      },
      {
        "id": "ChargeItemDefinition.code",
        "path": "ChargeItemDefinition.code",
        "short": "Rebate Type",
        "definition": "#### **_`Rebate type.  Examples: Guaranteed, Contingent, etc...`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.code.coding",
        "path": "ChargeItemDefinition.code.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ChargeItemDefinition.code.coding.system",
        "path": "ChargeItemDefinition.code.coding.system",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.code.coding.version",
        "path": "ChargeItemDefinition.code.coding.version",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.code.coding.code",
        "path": "ChargeItemDefinition.code.coding.code",
        "short": "Rebate type code",
        "definition": "#### **_`Rebate type code.  `_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.code.coding.display",
        "path": "ChargeItemDefinition.code.coding.display",
        "short": "Rebate Type",
        "definition": "#### **_`Rebate type.  Examples: Guaranteed,Contingent`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.code.coding.userSelected",
        "path": "ChargeItemDefinition.code.coding.userSelected",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.code.text",
        "path": "ChargeItemDefinition.code.text",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.instance",
        "path": "ChargeItemDefinition.instance",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.applicability",
        "path": "ChargeItemDefinition.applicability",
        "short": "Rebate Details",
        "definition": "#### **_`Rebate Details.`_**",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ChargeItemDefinition.applicability.condition",
        "path": "ChargeItemDefinition.applicability.condition",
        "short": "Rebate Formula",
        "definition": "#### **_`Rebate formula and description of the formula`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.applicability.condition.description",
        "path": "ChargeItemDefinition.applicability.condition.description",
        "short": "Formula Description",
        "definition": "#### **_`Description of the rebate formula.`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.applicability.condition.name",
        "path": "ChargeItemDefinition.applicability.condition.name",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.applicability.condition.language",
        "path": "ChargeItemDefinition.applicability.condition.language",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.applicability.condition.expression",
        "path": "ChargeItemDefinition.applicability.condition.expression",
        "short": "Formula",
        "definition": "#### **_`The rebate formula SAS executes.`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.applicability.condition.reference",
        "path": "ChargeItemDefinition.applicability.condition.reference",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.applicability.effectivePeriod",
        "path": "ChargeItemDefinition.applicability.effectivePeriod",
        "short": "Rebate Period",
        "definition": "#### **_`Effective Date and End Date.   Typically present in rebates which involve caps.    May have to be manually calculated in cases when PLAs only specify effective contract years (e.g. Rebate is effective for contract years 1-3)  .  Expiry date is used when the PLA specifies an end date for the rebate. Alternatively, ineff_date is used when there is a change in the rebate.`_**",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.applicability.effectivePeriod.start",
        "path": "ChargeItemDefinition.applicability.effectivePeriod.start",
        "min": 1
      },
      {
        "id": "ChargeItemDefinition.applicability.relatedArtifact",
        "path": "ChargeItemDefinition.applicability.relatedArtifact",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.propertyGroup",
        "path": "ChargeItemDefinition.propertyGroup",
        "short": "Input Values for Formula",
        "definition": "#### **_`Input values needed for the SAS fomula calculation.  Examples:  discount price 1 to 6.`_**"
      },
      {
        "id": "ChargeItemDefinition.propertyGroup.applicability",
        "path": "ChargeItemDefinition.propertyGroup.applicability",
        "max": "0"
      },
      {
        "id": "ChargeItemDefinition.propertyGroup.priceComponent",
        "path": "ChargeItemDefinition.propertyGroup.priceComponent",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ChargeItemDefinition.propertyGroup.priceComponent.code",
        "path": "ChargeItemDefinition.propertyGroup.priceComponent.code",
        "max": "0"
      }
    ]
  }
}