| <?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 & 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="OperationDefinition" type="OperationDefinition"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:complexType name="OperationDefinition"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</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="0" maxOccurs="1" type="uri"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">An absolute URI that is used to identify this operation 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 operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.</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 operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation 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.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="name" minOccurs="1" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.</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 operation definition.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="status" minOccurs="1" maxOccurs="1" type="PublicationStatus"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The status of this operation definition. Enables tracking the life-cycle of the content.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="kind" minOccurs="1" maxOccurs="1" type="OperationKind"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Whether this is an operation or a named query.</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 operation 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 operation 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 operation 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 operation 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 operation 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 operation 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 operation definition is intended to be used.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="purpose" minOccurs="0" maxOccurs="1" type="markdown"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Explanation of why this operation definition is needed and why it has been designed as it has.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="affectsState" minOccurs="0" maxOccurs="1" type="boolean"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="code" minOccurs="1" maxOccurs="1" type="code"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The name used to invoke the operation.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="comment" minOccurs="0" maxOccurs="1" type="markdown"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Additional information about how to use this operation or named query.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="base" minOccurs="0" maxOccurs="1" type="canonical"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Indicates that this operation definition is a constraining profile on the base.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="resource" minOccurs="0" maxOccurs="unbounded" type="code"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The types on which this operation can be executed.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="system" minOccurs="1" maxOccurs="1" type="boolean"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="type" minOccurs="1" maxOccurs="1" type="boolean"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="instance" minOccurs="1" maxOccurs="1" type="boolean"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Indicates whether this operation can be invoked on a particular instance of one of the given types.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="inputProfile" minOccurs="0" maxOccurs="1" type="canonical"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="outputProfile" minOccurs="0" maxOccurs="1" type="canonical"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="parameter" type="OperationDefinition.Parameter" minOccurs="0" maxOccurs="unbounded"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The parameters for the operation/query.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="overload" type="OperationDefinition.Overload" minOccurs="0" maxOccurs="unbounded"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| </xs:sequence> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:complexType name="OperationDefinition.Parameter"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</xs:documentation> | |
| </xs:annotation> | |
| <xs:complexContent> | |
| <xs:extension base="BackboneElement"> | |
| <xs:sequence> | |
| <xs:element name="name" minOccurs="1" maxOccurs="1" type="code"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The name of used to identify the parameter.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="use" minOccurs="1" maxOccurs="1" type="OperationParameterUse"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Whether this is an input or an output parameter.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="min" minOccurs="1" maxOccurs="1" type="integer"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The minimum number of times this parameter SHALL appear in the request or response.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="max" minOccurs="1" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The maximum number of times this element is permitted to appear in the request or response.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="documentation" minOccurs="0" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Describes the meaning or use of this parameter.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="type" minOccurs="0" maxOccurs="1" type="code"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The type for this parameter.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="targetProfile" minOccurs="0" maxOccurs="unbounded" type="canonical"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="searchType" minOccurs="0" maxOccurs="1" type="SearchParamType"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="binding" type="OperationDefinition.Binding" minOccurs="0" maxOccurs="1"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="referencedFrom" type="OperationDefinition.ReferencedFrom" minOccurs="0" maxOccurs="unbounded"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="part" type="OperationDefinition.Parameter" minOccurs="0" maxOccurs="unbounded"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The parts of a nested Parameter.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| </xs:sequence> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:complexType name="OperationDefinition.Binding"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</xs:documentation> | |
| </xs:annotation> | |
| <xs:complexContent> | |
| <xs:extension base="BackboneElement"> | |
| <xs:sequence> | |
| <xs:element name="strength" minOccurs="1" maxOccurs="1" type="BindingStrength"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="valueSet" minOccurs="1" maxOccurs="1" type="canonical"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| </xs:sequence> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:complexType name="OperationDefinition.ReferencedFrom"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</xs:documentation> | |
| </xs:annotation> | |
| <xs:complexContent> | |
| <xs:extension base="BackboneElement"> | |
| <xs:sequence> | |
| <xs:element name="source" minOccurs="1" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="sourceId" minOccurs="0" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">The id of the element in the referencing resource that is expected to resolve to this resource.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| </xs:sequence> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:complexType name="OperationDefinition.Overload"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).</xs:documentation> | |
| </xs:annotation> | |
| <xs:complexContent> | |
| <xs:extension base="BackboneElement"> | |
| <xs:sequence> | |
| <xs:element name="parameterName" minOccurs="0" maxOccurs="unbounded" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Name of parameter to include in overload.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| <xs:element name="comment" minOccurs="0" maxOccurs="1" type="string"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Comments to go on overload.</xs:documentation> | |
| </xs:annotation> | |
| </xs:element> | |
| </xs:sequence> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:simpleType name="OperationParameterUse-list"> | |
| <xs:restriction base="code-primitive"> | |
| <xs:enumeration value="in"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">In</xs:documentation> | |
| </xs:annotation> | |
| </xs:enumeration> | |
| <xs:enumeration value="out"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Out</xs:documentation> | |
| </xs:annotation> | |
| </xs:enumeration> | |
| </xs:restriction> | |
| </xs:simpleType> | |
| <xs:complexType name="OperationParameterUse"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Whether an operation parameter is an input or an output parameter.</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="OperationParameterUse-list" use="optional"/> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| <xs:simpleType name="OperationKind-list"> | |
| <xs:restriction base="code-primitive"> | |
| <xs:enumeration value="operation"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Operation</xs:documentation> | |
| </xs:annotation> | |
| </xs:enumeration> | |
| <xs:enumeration value="query"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Query</xs:documentation> | |
| </xs:annotation> | |
| </xs:enumeration> | |
| </xs:restriction> | |
| </xs:simpleType> | |
| <xs:complexType name="OperationKind"> | |
| <xs:annotation> | |
| <xs:documentation xml:lang="en">Whether an operation is a normal operation or a query.</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="OperationKind-list" use="optional"/> | |
| </xs:extension> | |
| </xs:complexContent> | |
| </xs:complexType> | |
| </xs:schema> |