Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Example ChargeItemDefinition/device (JSON)

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

instance-specific billing information for a device with time-dependent tax rate

{
  "resourceType" : "ChargeItemDefinition",
  "id" : "device",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: ChargeItemDefinition</b><a name=\"device\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource ChargeItemDefinition &quot;device&quot; </p></div><p><b>url</b>: <code>http://sap.org/ChargeItemDefinition/device-123</code></p><p><b>identifier</b>: id:\u00a0urn:oid:2.16.840.1.113883.4.642.29.2</p><p><b>name</b>: CustomDevice345675</p><p><b>title</b>: Financial details for custom made device (345675)</p><p><b>status</b>: active</p><p><b>date</b>: 2023-02</p><p><b>publisher</b>: Example Publisher</p><p><b>description</b>: Financial details for custom made device</p><h3>UseContexts</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>Clinical Venue (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code venue = 'Clinical Venue', stated as 'null')</td><td>Outpatient environment <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#440655000)</span></td></tr><tr><td>*</td><td>Age Range (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code age = 'Age Range', stated as 'null')</td><td>&gt;18 yrs<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code a = 'a')</span></td></tr></table><p><b>jurisdiction</b>: World <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (m49.htm#001)</span></p><p><b>instance</b>: <a href=\"device-example.html\">Device/example</a></p><blockquote><p><b>applicability</b></p><h3>Conditions</h3><table class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td>*</td><td>Verify ChargeItem pertains to Device 12345</td><td>text/fhirpath</td><td><span title=\"  syntax of expression may be incorrect, but you get the idea \">%context.service.suppliedItem.reference='Device/12345'</span></td></tr></table></blockquote><blockquote><p><b>propertyGroup</b></p><blockquote><p><b>priceComponent</b></p><p><b>type</b>: base</p><p><b>code</b>: Verkaufspreis (netto) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (billing-attributes#VK)</span></p><blockquote><p><b>amount</b></p><p><span title=\"Euro\">€67.44</span> (EUR)</p></blockquote></blockquote></blockquote><blockquote><p><b>propertyGroup</b></p><blockquote><p><b>applicability</b></p><blockquote><p><b>condition</b></p><p><span title=\"text/fhirpath\"><code>%context.occurenceDateTime &gt; '2018-04-01'</code></span>(&quot;Gültigkeit Steuersatz&quot;)</p></blockquote></blockquote><h3>PriceComponents</h3><table class=\"grid\"><tr><td>-</td><td><b>Type</b></td><td><b>Code</b></td><td><b>Factor</b></td></tr><tr><td>*</td><td>tax</td><td>Mehrwersteuersatz <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (billing-attributes#MWST)</span></td><td>1.19</td></tr></table></blockquote><blockquote><p><b>propertyGroup</b></p><blockquote><p><b>applicability</b></p><blockquote><p><b>condition</b></p><p><span title=\"text/fhirpath\"><code>%context.occurenceDateTime &lt;= '2018-04-01'</code></span>(&quot;Gültigkeit Steuersatz&quot;)</p></blockquote></blockquote><h3>PriceComponents</h3><table class=\"grid\"><tr><td>-</td><td><b>Type</b></td><td><b>Code</b></td><td><b>Factor</b></td></tr><tr><td>*</td><td>tax</td><td>Mehrwersteuersatz <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (billing-attributes#MWST)</span></td><td>1.07</td></tr></table></blockquote></div>"
  },
  "url" : "http://sap.org/ChargeItemDefinition/device-123",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.29.2"
  }],
  "name" : "CustomDevice345675",
  "title" : "Financial details for custom made device (345675)",
  "status" : "active",
  "date" : "2023-02",
  "publisher" : "Example Publisher",
  "description" : "Financial details for custom made device",
  "useContext" : [{
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "venue"
    },
    "valueCodeableConcept" : {
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "440655000",
        "display" : "Outpatient environment"
      }]
    }
  },
  {
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "age"
    },
    "valueQuantity" : {
      "value" : 18,
      "comparator" : ">",
      "unit" : "yrs",
      "system" : "http://unitsofmeasure.org",
      "code" : "a"
    }
  }],
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "instance" : [{
    "reference" : "Device/example"
  }],
  "applicability" : [{
    "condition" : {
      "description" : "Verify ChargeItem pertains to Device 12345",
      "language" : "text/fhirpath",
      "expression" : "%context.service.suppliedItem.reference='Device/12345'"
    }
  }],
  "propertyGroup" : [{
    "priceComponent" : [{
      "type" : "base",
      "code" : {
        "coding" : [{
          "system" : "http://fhir.de/CodeSystem/billing-attributes",
          "code" : "VK",
          "display" : "Verkaufspreis (netto)"
        }]
      },
      "amount" : {
        "value" : 67.44,
        "currency" : "EUR"
      }
    }]
  },
  {
    "applicability" : [{
      "condition" : {
        "description" : "Gültigkeit Steuersatz",
        "language" : "text/fhirpath",
        "expression" : "%context.occurenceDateTime > '2018-04-01'"
      }
    }],
    "priceComponent" : [{
      "type" : "tax",
      "code" : {
        "coding" : [{
          "system" : "http://fhir.de/CodeSystem/billing-attributes",
          "code" : "MWST",
          "display" : "Mehrwersteuersatz"
        }]
      },
      "factor" : 1.19
    }]
  },
  {
    "applicability" : [{
      "condition" : {
        "description" : "Gültigkeit Steuersatz",
        "language" : "text/fhirpath",
        "expression" : "%context.occurenceDateTime <= '2018-04-01'"
      }
    }],
    "priceComponent" : [{
      "type" : "tax",
      "code" : {
        "coding" : [{
          "system" : "http://fhir.de/CodeSystem/billing-attributes",
          "code" : "MWST",
          "display" : "Mehrwersteuersatz"
        }]
      },
      "factor" : 1.07
    }]
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.