This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Profile for conformance
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="conformance-definitions.html#Conformance" title="A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation."><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="conformance-definitions.html#Conformance.identifier" title="The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)."><b>identifier</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Logical id to reference this statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.version" title="The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp."><b>version</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Logical id for this version of the statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.name" title="A free text natural language name identifying the conformance statement."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Informal name for this conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.publisher" title="Name of Organization publishing this conformance statement."><b>publisher</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Publishing Organization<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.telecom" title="Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc."><b>telecom</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Contact">Contact</a></span> <span style="color: navy">Contacts for Organization<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="conformance-definitions.html#Conformance.description" title="A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP."><b>description</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Human description of the conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.status" title="The status of this conformance statement (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>status</b></span></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy"><a href="conformance-statement-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.experimental" title="A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><b>experimental</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">If for testing purposes, not real usage<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.date" title="The date when the conformance statement was published."><b>date</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Publication Date<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software" title="Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation."><b>software</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> Software that is covered by this conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.name" title="Name software is known by."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">A name the software is known by<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.version" title="The version identifier for the software covered by this statement."><b>version</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Version covered by this statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.releaseDate" title="Date this version of the software released."><b>releaseDate</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Date this version released<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </software> <<a class="dict" href="conformance-definitions.html#Conformance.implementation" title="Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program."><b>implementation</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> If this describes a specific instance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.description" title="Information about the specific installation that this conformance statement relates to."><b>description</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Describes this specific instance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.url" title="A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."><b>url</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Base URL for the installation<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </implementation> <<a class="dict" href="conformance-definitions.html#Conformance.fhirVersion" title="The version of the FHIR specification on which this conformance statement is based."><b>fhirVersion</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#id">id</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">FHIR Version<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.acceptUnknown" title="A flag that indicates whether the application accepts unknown elements as part of a resource."><b>acceptUnknown</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">True if application accepts unknown elements<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.format" title="A list of the formats supported by this implementation."><b>format</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..*</b></span> <span style="color: navy"><a href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">formats supported (xml | json | mime type)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.profile" title="A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile."><b>profile</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="profile.html#Profile">Profile</a>)</span> <span style="color: navy">Profiles supported by the system</span><span style="color: Gray"> --></span></profile> <<a class="dict" href="conformance-definitions.html#Conformance.rest" title="A definition of the restful capabilities of the solution, if any."><b>rest</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If the endpoint is a RESTful one --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.mode" title="Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."><b>mode</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="restful-conformance-mode.html" style="color: navy">client | server</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentation" title="Information about the system's restful capabilities that apply across all applications, such as security."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">General description of implementation</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security" title="Information about security of implementation."><b>security</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Information about security of implementation --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.cors" title="Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server."><b>cors</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Adds CORS Headers (http://enable-cors.org/)</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.service" title="Types of security services are supported/required by the system."><b>service</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="restful-security-service.html" style="color: navy">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style="color: Gray"> --></span></service> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.description" title="General description of how security works."><b>description</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">General description of how security works</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate" title="Certificates associated with security profiles."><b>certificate</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Certificates associated with security profiles --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.type" title="Mime type for certificate."><b>type</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy"><a href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">Mime type for certificate</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.blob" title="Actual certificate."><b>blob</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#base64Binary">base64Binary</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Actual certificate</span><span style="color: Gray"> --></span> </certificate> </security> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource" title="A specification of the restful capabilities of the solution for a specific resource type."><b>resource</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Resource served on the REST interface --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.type" title="A type of resource exposed via the restful interface."><b>type</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="resource-types.html" style="color: navy">A resource type that is supported</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.profile" title="A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations."><b>profile</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="profile.html#Profile">Profile</a>)</span> <span style="color: navy">What structural features are supported</span><span style="color: Gray"> --></span></profile> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation" title="Identifies a restful operation supported by the solution."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.code" title="Coded identifier of the operation, supported by the system resource."><b>code</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="type-restful-operation.html" style="color: navy">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.documentation" title="Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Anything special about operation behavior</span><span style="color: Gray"> --></span> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.readHistory" title="A flag for whether the server is able to return past versions as part of the vRead operation."><b>readHistory</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Whether vRead can return past versions</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.updateCreate" title="A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server."><b>updateCreate</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">If allows/uses update to a new location</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchInclude" title="A list of _include values supported by the server."><b>searchInclude</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy">_include values supported by the server</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam" title="Additional search parameters for implementations to support and/or make use of."><b>searchParam</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Additional search params defined --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.name" title="The name of the search parameter used in the interface."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Name of search parameter</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.definition" title="A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter."><b>definition</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Source of definition for parameter</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.type" title="The type of value a search parameter refers to, and how the content is interpreted."><b>type</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="search-param-type.html" style="color: navy">number | date | string | token | reference | composite | quantity</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.documentation" title="This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Server-specific usage</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.target" title="Types of resource (if a resource is referenced)."><b>target</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy"><a href="resource-types.html" style="color: navy">Types of resource (if a resource reference)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.chain" title="Chained names supported."><b>chain</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy">Chained names supported</span><span style="color: Gray"> --></span> </searchParam> </resource> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation" title="A specification of restful operations supported by the system."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.code" title="A coded identifier of the operation, supported by the system."><b>code</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="system-restful-operation.html" style="color: navy">transaction | search-system | history-system</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.documentation" title="Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Anything special about operation behavior</span><span style="color: Gray"> --></span> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query" title="Definition of a named query and its parameters and their meaning."><b>query</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Definition of a named query --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.name" title="The name of a query, which is used in the _query parameter when the query is called."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Special named queries (_query=)</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.definition" title="Identifies the custom query, defined either in FHIR core or another profile."><b>definition</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Where query is defined</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.documentation" title="Additional information about how the query functions in this particular implementation."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Additional usage guidance</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.parameter" title="Identifies which of the parameters for the named query are supported."><b>parameter</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen">Content as for Conformance.rest.resource.searchParam</span> <span style="color: navy">Parameter for the named query</span><span style="color: Gray"> --></span></parameter> </query> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentMailbox" title="A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier "http://hl7.org/fhir/documents/mailbox". Other specifications can declare their own identifier for this purpose."><b>documentMailbox</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy">How documents are accepted in /Mailbox</span><span style="color: Gray"> --></span> </rest> <<a class="dict" href="conformance-definitions.html#Conformance.messaging" title="A description of the messaging capabilities of the solution."><b>messaging</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If messaging is supported --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.endpoint" title="An address to which messages and/or replies are to be sent."><b>endpoint</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Actual endpoint being described</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.reliableCache" title="Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender)."><b>reliableCache</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Reliable Message Cache Length</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.documentation" title="Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Messaging interface behavior details</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event" title="A description of the solution's support for an event at this end point."><b>event</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Declare support for this event --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.code" title="A coded identifier of a supported messaging event."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="message-events.html" style="color: navy">Event type</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.category" title="The impact of the content of the message."><b>category</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy"><a href="message-significance-category.html" style="color: navy">Consequence | Currency | Notification</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.mode" title="The mode of this event declaration - whether application is sender or receiver."><b>mode</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="message-conformance-event-mode.html" style="color: navy">sender | receiver</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.protocol" title="A list of the messaging transport protocol(s) identifiers, supported by this endpoint."><b>protocol</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="message-transport.html" style="color: navy">http | ftp | mllp +</a></span><span style="color: Gray"> --></span></protocol> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.focus" title="A resource associated with the event. This is the resource that defines the event."><b>focus</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="resource-types.html" style="color: navy">Resource that's focus of message</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.request" title="Information about the request for this event."><b>request</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="profile.html#Profile">Profile</a>)</span> <span style="color: navy">Profile that describes the request</span><span style="color: Gray"> --></span></request> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.response" title="Information about the response for this event."><b>response</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="profile.html#Profile">Profile</a>)</span> <span style="color: navy">Profile that describes the response</span><span style="color: Gray"> --></span></response> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.documentation" title="Guidance on how this event is handled, such as internal system trigger points, business rules, etc."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Endpoint-specific event documentation</span><span style="color: Gray"> --></span> </event> </messaging> <<a class="dict" href="conformance-definitions.html#Conformance.document" title="A document definition."><b>document</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> Document definition --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.mode" title="Mode of this document declaration - whether application is producer or consumer."><b>mode</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="document-mode.html" style="color: navy">producer | consumer</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.documentation" title="A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc."><b>documentation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Description of document support</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.profile" title="A constraint on a resource used in the document."><b>profile</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="profile.html#Profile">Profile</a>)</span> <span style="color: navy">Constraint on a resource used in the document</span><span style="color: Gray"> --></span></profile> </document> </Conformance> </pre></div> </text> <name value="conformance"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Conformance statements are used in one of three ways: Describe an actual implementation In this scenario, the conformance statement describes the capabilities of a deployed and configured solution available at a particular access point or set of access points. The statement describes exactly how to interface with that deployed solution and thus provides for a degree of self-configuration of software solutions. This is the type of profile that FHIR restful solutions are expected to make available on invocation of the conformance operation. It is also the type of statement that forms a basis for the testing, certification or commissioning of specific software installations. A conformance statement is identified as being an implementation statement through the presence of the implementation element. Describe software solution capabilities In this scenario, the conformance statement describes generic capabilities of a software application or component solution. The solution might be available for purchase or other acquisition and might be deployed and configured at any number of independent sites. Because it is not dependent on any particular implementation, the profile cannot provide specific details such as endpoint addresses. It may also need to document various configurations in which the application can be set up or describe the degree of customizability associated with the solution. This type of statement may be used as a marketing tool by software and system developers to formally describe their capabilities. It can also be used as the basis for conformance testing of software solutions independent of a particular installation. A conformance statement is identified as being a software solution statement through the presence of the software element. Describe a desired solution In this scenario, the conformance statement describes the capabilities of a desired system. It might be used as part of an architectural design process to document needed system capabilities, or might be used as part of an RFP process to formally document the requirements of a requested solution and to document the criteria by which proposals will be evaluated. A conformance statement is identified as being a requirements statement through the presence of the proposal element. These three types of profiles can be used together. A requirements statement can be compared against the solution statements proffered by respondents to an RFP. A solution statement for a software package forms the starting point for the implementation statement associated with a particular installation of that software package."/> <structure> <type value="Conformance"/> <publish value="true"/> <element> <path value="Conformance"/> <definition> <short value="A conformance statement"/> <formal value="A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="Details"/> <severity value="error"/> <human value="A Conformance statement SHALL have at least one of description, software, or implementation"/> <xpath value="count(f:software | f:implementation | f:description) > 0"/> </constraint> <constraint> <key value="1"/> <name value="Content Required"/> <severity value="error"/> <human value="A Conformance statement SHALL have at least one of rest, messaging or document"/> <xpath value="exists(f:rest) or exists(f:messaging) or exists(f:document)"/> </constraint> <constraint> <key value="7"/> <name value="Document unique"/> <severity value="error"/> <human value="The set of documents must be unique by the combination of profile & mode"/> <xpath value="count(f:document[f:mode='producer'])=count(distinct-values(f:document[f:mode='producer']/f:profile/@ value)) and count(f:document[f:mode='consumer'])=count(distinct-values(f:document[f:mode='consumer']/ f:profile/@value))"/> </constraint> <constraint> <key value="5"/> <name value="Messaging endpoints unique"/> <severity value="error"/> <human value="The set of end points listed for messaging must be unique"/> <xpath value="count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))"/> </constraint> <constraint> <key value="4"/> <name value="End point populated when multiple"/> <severity value="error"/> <human value="If there is more than one messaging element, endpoint must be specified for each one"/> <xpath value="count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])"/> </constraint> <constraint> <key value="8"/> <name value="Rest unique by mode"/> <severity value="error"/> <human value="There can only be one REST declaration per mode"/> <xpath value="count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.identifier"/> <definition> <short value="Logical id to reference this statement"/> <formal value="The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.version"/> <definition> <short value="Logical id for this version of the statement"/> <formal value="The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp."/> <comments value="There may be multiple different instances of a conformance statement that have the same identifier but different versions."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.name"/> <definition> <short value="Informal name for this conformance statement"/> <formal value="A free text natural language name identifying the conformance statement."/> <comments value="The name is not expected to be globally unique."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.publisher"/> <definition> <short value="Publishing Organization"/> <formal value="Name of Organization publishing this conformance statement."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.telecom"/> <definition> <short value="Contacts for Organization"/> <formal value="Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.description"/> <definition> <short value="Human description of the conformance statement"/> <formal value="A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP."/> <comments value="This field cmay include the purpose of this conformance statement, comments about its context etc. This does not need to be populated if the description is adequately implied by the software or implementation details."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.status"/> <definition> <short value="draft | active | retired"/> <formal value="The status of this conformance statement."/> <comments value="This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConformanceStatementStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/conformance-statement-status"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.experimental"/> <definition> <short value="If for testing purposes, not real usage"/> <formal value="A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <comments value="Allows filtering of conformance statements that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.date"/> <definition> <short value="Publication Date"/> <formal value="The date when the conformance statement was published."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software"/> <definition> <short value="Software that is covered by this conformance statement"/> <formal value="Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.name"/> <definition> <short value="A name the software is known by"/> <formal value="Name software is known by."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.version"/> <definition> <short value="Version covered by this statement"/> <formal value="The version identifier for the software covered by this statement."/> <comments value="If possible, version should be specified, as statements are likely to be different for different versions of software."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.releaseDate"/> <definition> <short value="Date this version released"/> <formal value="Date this version of the software released."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation"/> <definition> <short value="If this describes a specific instance"/> <formal value="Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.description"/> <definition> <short value="Describes this specific instance"/> <formal value="Information about the specific installation that this conformance statement relates to."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.url"/> <definition> <short value="Base URL for the installation"/> <formal value="A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.fhirVersion"/> <definition> <short value="FHIR Version"/> <formal value="The version of the FHIR specification on which this conformance statement is based."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.acceptUnknown"/> <definition> <short value="True if application accepts unknown elements"/> <formal value="A flag that indicates whether the application accepts unknown elements as part of a resource."/> <comments value="This is not about extensions, but about unknown elements in a resource - these can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence this element is about inter-version compatibility."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.format"/> <definition> <short value="formats supported (xml | json | mime type)"/> <formal value="A list of the formats supported by this implementation."/> <comments value=""xml" or "json" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here."/> <min value="1"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MimeType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> </definition> </element> <element> <path value="Conformance.profile"/> <definition> <short value="Profiles supported by the system"/> <formal value="A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile."/> <comments value="Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports- this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). Typical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However they do not need to describe more than one resource."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest"/> <definition> <short value="If the endpoint is a RESTful one"/> <formal value="A definition of the restful capabilities of the solution, if any."/> <comments value="Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements)."/> <min value="0"/> <max value="*"/> <constraint> <key value="10"/> <name value="Query unique in rest mode"/> <severity value="error"/> <human value="A given query can only be described once per RESTful mode"/> <xpath value="count(f:query)=count(distinct-values(f:query/f:name/@value))"/> </constraint> <constraint> <key value="9"/> <name value="Resource unique in rest mode"/> <severity value="error"/> <human value="A given resource can only be described once per RESTful mode"/> <xpath value="count(f:resource)=count(distinct-values(f:resource/f:type/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.mode"/> <definition> <short value="client | server"/> <formal value="Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulConformanceMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/restful-conformance-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.documentation"/> <definition> <short value="General description of implementation"/> <formal value="Information about the system's restful capabilities that apply across all applications, such as security."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security"/> <definition> <short value="Information about security of implementation"/> <formal value="Information about security of implementation."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.cors"/> <definition> <short value="Adds CORS Headers (http://enable-cors.org/)"/> <formal value="Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server."/> <comments value="The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Meth od: GET, POST, PUT, DELETE."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.service"/> <definition> <short value="OAuth | OAuth2 | NTLM | Basic | Kerberos"/> <formal value="Types of security services are supported/required by the system."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RestfulSecurityService"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/restful-security-service"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.security.description"/> <definition> <short value="General description of how security works"/> <formal value="General description of how security works."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate"/> <definition> <short value="Certificates associated with security profiles"/> <formal value="Certificates associated with security profiles."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.type"/> <definition> <short value="Mime type for certificate"/> <formal value="Mime type for certificate."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MimeType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> </definition> </element> <element> <path value="Conformance.rest.security.certificate.blob"/> <definition> <short value="Actual certificate"/> <formal value="Actual certificate."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource"/> <definition> <short value="Resource served on the REST interface"/> <formal value="A specification of the restful capabilities of the solution for a specific resource type."/> <comments value="Max of one repetition per resource type."/> <min value="1"/> <max value="*"/> <constraint> <key value="11"/> <name value="Operation unique in resource"/> <severity value="error"/> <human value="Operation codes must be unique in the context of a resource"/> <xpath value="count(f:operation)=count(distinct-values(f:operation/f:code/@value))"/> </constraint> <constraint> <key value="12"/> <name value="SearchParam unique in resource"/> <severity value="error"/> <human value="Search parameter names must be unique in the context of a resource"/> <xpath value="count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.type"/> <definition> <short value="A resource type that is supported"/> <formal value="A type of resource exposed via the restful interface."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.profile"/> <definition> <short value="What structural features are supported"/> <formal value="A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations."/> <comments value="The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation"/> <definition> <short value="What operations are supported?"/> <formal value="Identifies a restful operation supported by the solution."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.code"/> <definition> <short value="read | vread | update | delete | history-instance | validate | history-type | create | search-type"/> <formal value="Coded identifier of the operation, supported by the system resource."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulOperationType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/type-restful-operation"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.operation.documentation"/> <definition> <short value="Anything special about operation behavior"/> <formal value="Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.readHistory"/> <definition> <short value="Whether vRead can return past versions"/> <formal value="A flag for whether the server is able to return past versions as part of the vRead operation."/> <comments value="It is useful to support the vRead operation for current operations, even if past versions aren't available."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.updateCreate"/> <definition> <short value="If allows/uses update to a new location"/> <formal value="A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server."/> <comments value="Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchInclude"/> <definition> <short value="_include values supported by the server"/> <formal value="A list of _include values supported by the server."/> <comments value="If this list is empty, the server does not support includes."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam"/> <definition> <short value="Additional search params defined"/> <formal value="Additional search parameters for implementations to support and/or make use of."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.name"/> <definition> <short value="Name of search parameter"/> <formal value="The name of the search parameter used in the interface."/> <comments value="Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.definition"/> <definition> <short value="Source of definition for parameter"/> <formal value="A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter."/> <comments value="This SHALL be populated for all search parameters not defined as part of the core FHIR specification. The uri is the uri of the profile defining the parameter followed by "#" followed by the structure name and search parameter name."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.type"/> <definition> <short value="number | date | string | token | reference | composite | quantity"/> <formal value="The type of value a search parameter refers to, and how the content is interpreted."/> <comments value="While this can be looked up from the definition, it is included here as a convenience for systems that auto-generate a query interface based on the server conformance statement. It SHALL be the same as the type in the search parameter definition."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SearchParamType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/search-param-type"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.documentation"/> <definition> <short value="Server-specific usage"/> <formal value="This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.target"/> <definition> <short value="Types of resource (if a resource reference)"/> <formal value="Types of resource (if a resource is referenced)."/> <comments value="This SHALL be the same as or a proper subset of the resources listed in the search parameter definition."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.chain"/> <definition> <short value="Chained names supported"/> <formal value="Chained names supported."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation"/> <definition> <short value="What operations are supported?"/> <formal value="A specification of restful operations supported by the system."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.code"/> <definition> <short value="transaction | search-system | history-system"/> <formal value="A coded identifier of the operation, supported by the system."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulOperationSystem"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/system-restful-operation"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.operation.documentation"/> <definition> <short value="Anything special about operation behavior"/> <formal value="Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query"/> <definition> <short value="Definition of a named query"/> <formal value="Definition of a named query and its parameters and their meaning."/> <min value="0"/> <max value="*"/> <constraint> <key value="13"/> <name value="SearchParam unique in query"/> <severity value="error"/> <human value="Search parameter names must be unique in the context of a query"/> <xpath value="count(f:parameter)=count(distinct-values(f:parameter/f:name/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.name"/> <definition> <short value="Special named queries (_query=)"/> <formal value="The name of a query, which is used in the _query parameter when the query is called."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.definition"/> <definition> <short value="Where query is defined"/> <formal value="Identifies the custom query, defined either in FHIR core or another profile."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.documentation"/> <definition> <short value="Additional usage guidance"/> <formal value="Additional information about how the query functions in this particular implementation."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.parameter"/> <definition> <short value="Parameter for the named query"/> <formal value="Identifies which of the parameters for the named query are supported."/> <comments value="This SHALL be a proper subset of the parameters defined on the query definition."/> <min value="0"/> <max value="*"/> <nameReference value="Conformance.rest.resource.searchParam"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.documentMailbox"/> <definition> <short value="How documents are accepted in /Mailbox"/> <formal value="A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier "http://hl7.org/fhir/documents/mailbox". Other specifications can declare their own identifier for this purpose."/> <comments value="If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging"/> <definition> <short value="If messaging is supported"/> <formal value="A description of the messaging capabilities of the solution."/> <comments value="Multiple repetitions allow the documentation of multiple endpoints per solution."/> <min value="0"/> <max value="*"/> <constraint> <key value="3"/> <name value="End points for Implementations"/> <severity value="error"/> <human value="Messaging end point is required (and is only permitted) when statement is for an implementation"/> <xpath value="exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"/> </constraint> <constraint> <key value="6"/> <name value="Event unique"/> <severity value="error"/> <human value="The set of events per messaging endpoint must be unique by the combination of code & mode"/> <xpath value="count(f:event[f:mode='sender'])=count(distinct-values(f:event[f:mode='sender']/f:code/@value)) and count(f:event[f:mode='receiver'])=count(distinct-values(f:event[f:mode='receiver']/f:code/@value ))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.endpoint"/> <definition> <short value="Actual endpoint being described"/> <formal value="An address to which messages and/or replies are to be sent."/> <comments value="For solutions that do not use network addresses for routing, it can be just an identifier."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.reliableCache"/> <definition> <short value="Reliable Message Cache Length"/> <formal value="Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender)."/> <comments value="If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.documentation"/> <definition> <short value="Messaging interface behavior details"/> <formal value="Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event"/> <definition> <short value="Declare support for this event"/> <formal value="A description of the solution's support for an event at this end point."/> <comments value="The same event may be listed up to two times - once as sender and once as receiver."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.code"/> <definition> <short value="Event type"/> <formal value="A coded identifier of a supported messaging event."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/message-events"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.category"/> <definition> <short value="Consequence | Currency | Notification"/> <formal value="The impact of the content of the message."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MessageSignificanceCategory"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-significance-category"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.mode"/> <definition> <short value="sender | receiver"/> <formal value="The mode of this event declaration - whether application is sender or receiver."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ConformanceEventMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-conformance-event-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.protocol"/> <definition> <short value="http | ftp | mllp +"/> <formal value="A list of the messaging transport protocol(s) identifiers, supported by this endpoint."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="MessageTransport"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-transport"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.focus"/> <definition> <short value="Resource that's focus of message"/> <formal value="A resource associated with the event. This is the resource that defines the event."/> <comments value="This SHALL be provided if the event type supports multiple different resource types."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.request"/> <definition> <short value="Profile that describes the request"/> <formal value="Information about the request for this event."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.response"/> <definition> <short value="Profile that describes the response"/> <formal value="Information about the response for this event."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.documentation"/> <definition> <short value="Endpoint-specific event documentation"/> <formal value="Guidance on how this event is handled, such as internal system trigger points, business rules, etc."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document"/> <definition> <short value="Document definition"/> <formal value="A document definition."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.mode"/> <definition> <short value="producer | consumer"/> <formal value="Mode of this document declaration - whether application is producer or consumer."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DocumentMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/document-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.document.documentation"/> <definition> <short value="Description of document support"/> <formal value="A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.profile"/> <definition> <short value="Constraint on a resource used in the document"/> <formal value="A constraint on a resource used in the document."/> <comments value="The first resource is the document resource."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The conformance statement publication date"/> <xpath value="f:Conformance/f:date"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Text search in the description of the conformance statement"/> <xpath value="f:Conformance/f:description"/> </searchParam> <searchParam> <name value="event"/> <type value="token"/> <documentation value="Event code in a conformance statement"/> <xpath value="f:Conformance/f:messaging/f:event/f:code"/> </searchParam> <searchParam> <name value="fhirversion"/> <type value="token"/> <documentation value="The version of FHIR"/> <xpath value="f:Conformance/f:version"/> </searchParam> <searchParam> <name value="format"/> <type value="token"/> <documentation value="formats supported (xml | json | mime type)"/> <xpath value="f:Conformance/f:format"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="The identifier of the conformance statement"/> <xpath value="f:Conformance/f:identifier"/> </searchParam> <searchParam> <name value="mode"/> <type value="token"/> <documentation value="Mode - restful (server/client) or messaging (sender/receiver)"/> <xpath value="f:Conformance/f:rest/f:mode"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Name of the conformance statement"/> <xpath value="f:Conformance/f:name"/> </searchParam> <searchParam> <name value="profile"/> <type value="reference"/> <documentation value="A profile id invoked in a conformance statement"/> <xpath value="f:Conformance/f:rest/f:resource/f:profile"/> </searchParam> <searchParam> <name value="publisher"/> <type value="string"/> <documentation value="Name of the publisher of the conformance statement"/> <xpath value="f:Conformance/f:publisher"/> </searchParam> <searchParam> <name value="resource"/> <type value="token"/> <documentation value="Name of a resource mentioned in a conformance statement"/> <xpath value="f:Conformance/f:rest/f:resource/f:type"/> </searchParam> <searchParam> <name value="security"/> <type value="token"/> <documentation value="Information about security of implementation"/> <xpath value="f:Conformance/f:rest/f:security"/> </searchParam> <searchParam> <name value="software"/> <type value="string"/> <documentation value="Part of a the name of a software application"/> <xpath value="f:Conformance/f:software/f:name"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The current status of the conformance statement"/> <xpath value="f:Conformance/f:status"/> </searchParam> <searchParam> <name value="supported-profile"/> <type value="reference"/> <documentation value="Profiles supported by the system"/> <xpath value="f:Conformance/f:profile"/> </searchParam> <searchParam> <name value="version"/> <type value="token"/> <documentation value="The version identifier of the conformance statement"/> <xpath value="f:Conformance/f:version"/> </searchParam> </structure> </Profile>
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change