blob: dff0162a6ee0acf52a0cd20b9c806f54670e1f1c [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2011+, HL7, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of HL7 nor the names of its contributors may be used to
endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Generated on Thu, Dec 27, 2018 22:37+1100 for FHIR v4.0.0
Note: the schemas &amp; schematrons do not contain all of the rules about what makes resources
valid. Implementers will still need to be familiar with the content of the specification and with
any profiles that apply to the resources in order to make a conformant implementation.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hl7.org/fhir" xmlns:xhtml="http://www.w3.org/1999/xhtml" targetNamespace="http://hl7.org/fhir" elementFormDefault="qualified" version="1.0">
<xs:include schemaLocation="fhir-base.xsd"/>
<xs:element name="ChargeItemDefinition" type="ChargeItemDefinition">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ChargeItemDefinition">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
<xs:documentation xml:lang="en">If the element is present, it must have either a @value, an @id, or extensions</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="DomainResource">
<xs:sequence>
<xs:element name="url" minOccurs="1" maxOccurs="1" type="uri">
<xs:annotation>
<xs:documentation xml:lang="en">An 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 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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="identifier" minOccurs="0" maxOccurs="unbounded" type="Identifier">
<xs:annotation>
<xs:documentation xml:lang="en">A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="version" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">A short, descriptive, user-friendly title for the charge item definition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="derivedFromUri" minOccurs="0" maxOccurs="unbounded" type="uri">
<xs:annotation>
<xs:documentation xml:lang="en">The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="partOf" minOccurs="0" maxOccurs="unbounded" type="canonical">
<xs:annotation>
<xs:documentation xml:lang="en">A larger definition of which this particular definition is a component or step.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="replaces" minOccurs="0" maxOccurs="unbounded" type="canonical">
<xs:annotation>
<xs:documentation xml:lang="en">As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" minOccurs="1" maxOccurs="1" type="PublicationStatus">
<xs:annotation>
<xs:documentation xml:lang="en">The current state of the ChargeItemDefinition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="experimental" minOccurs="0" maxOccurs="1" type="boolean">
<xs:annotation>
<xs:documentation xml:lang="en">A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="date" minOccurs="0" maxOccurs="1" type="dateTime">
<xs:annotation>
<xs:documentation xml:lang="en">The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="publisher" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">The name of the organization or individual that published the charge item definition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="contact" minOccurs="0" maxOccurs="unbounded" type="ContactDetail">
<xs:annotation>
<xs:documentation xml:lang="en">Contact details to assist a user in finding and communicating with the publisher.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" minOccurs="0" maxOccurs="1" type="markdown">
<xs:annotation>
<xs:documentation xml:lang="en">A free text natural language description of the charge item definition from a consumer's perspective.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="useContext" minOccurs="0" maxOccurs="unbounded" type="UsageContext">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="jurisdiction" minOccurs="0" maxOccurs="unbounded" type="CodeableConcept">
<xs:annotation>
<xs:documentation xml:lang="en">A legal or geographic region in which the charge item definition is intended to be used.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="copyright" minOccurs="0" maxOccurs="1" type="markdown">
<xs:annotation>
<xs:documentation xml:lang="en">A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="approvalDate" minOccurs="0" maxOccurs="1" type="date">
<xs:annotation>
<xs:documentation xml:lang="en">The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastReviewDate" minOccurs="0" maxOccurs="1" type="date">
<xs:annotation>
<xs:documentation xml:lang="en">The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="effectivePeriod" minOccurs="0" maxOccurs="1" type="Period">
<xs:annotation>
<xs:documentation xml:lang="en">The period during which the charge item definition content was or is planned to be in active use.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="code" minOccurs="0" maxOccurs="1" type="CodeableConcept">
<xs:annotation>
<xs:documentation xml:lang="en">The defined billing details in this resource pertain to the given billing code.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="instance" minOccurs="0" maxOccurs="unbounded" type="Reference">
<xs:annotation>
<xs:documentation xml:lang="en">The defined billing details in this resource pertain to the given product instance(s).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="applicability" type="ChargeItemDefinition.Applicability" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation xml:lang="en">Expressions that describe applicability criteria for the billing code.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="propertyGroup" type="ChargeItemDefinition.PropertyGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation xml:lang="en">Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ChargeItemDefinition.Applicability">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="BackboneElement">
<xs:sequence>
<xs:element name="description" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">A brief, natural language description of the condition that effectively communicates the intended semantics.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="language" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">The media type of the language for the expression, e.g. &quot;text/cql&quot; for Clinical Query Language expressions or &quot;text/fhirpath&quot; for FHIRPath expressions.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="expression" minOccurs="0" maxOccurs="1" type="string">
<xs:annotation>
<xs:documentation xml:lang="en">An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ChargeItemDefinition.PropertyGroup">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="BackboneElement">
<xs:sequence>
<xs:element name="applicability" type="ChargeItemDefinition.Applicability" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation xml:lang="en">Expressions that describe applicability criteria for the priceComponent.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="priceComponent" type="ChargeItemDefinition.PriceComponent" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation xml:lang="en">The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ChargeItemDefinition.PriceComponent">
<xs:annotation>
<xs:documentation xml:lang="en">The 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.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="BackboneElement">
<xs:sequence>
<xs:element name="type" minOccurs="1" maxOccurs="1" type="InvoicePriceComponentType">
<xs:annotation>
<xs:documentation xml:lang="en">This code identifies the type of the component.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="code" minOccurs="0" maxOccurs="1" type="CodeableConcept">
<xs:annotation>
<xs:documentation xml:lang="en">A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="factor" minOccurs="0" maxOccurs="1" type="decimal">
<xs:annotation>
<xs:documentation xml:lang="en">The factor that has been applied on the base price for calculating this component.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="amount" minOccurs="0" maxOccurs="1" type="Money">
<xs:annotation>
<xs:documentation xml:lang="en">The amount calculated for this component.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="InvoicePriceComponentType-list">
<xs:restriction base="code-primitive">
<xs:enumeration value="base">
<xs:annotation>
<xs:documentation xml:lang="en">base price</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="surcharge">
<xs:annotation>
<xs:documentation xml:lang="en">surcharge</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="deduction">
<xs:annotation>
<xs:documentation xml:lang="en">deduction</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="discount">
<xs:annotation>
<xs:documentation xml:lang="en">discount</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="tax">
<xs:annotation>
<xs:documentation xml:lang="en">tax</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="informational">
<xs:annotation>
<xs:documentation xml:lang="en">informational</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="InvoicePriceComponentType">
<xs:annotation>
<xs:documentation xml:lang="en">Codes indicating the kind of the price component.</xs:documentation>
<xs:documentation xml:lang="en">If the element is present, it must have either a @value, an @id, or extensions</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Element">
<xs:attribute name="value" type="InvoicePriceComponentType-list" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:schema>