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
{ "resourceType": "Profile", "text": { "status": "generated", "div": "<div><pre>\r\n<<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance\"><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- 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> -->\r\n <<a 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).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.identifier\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.version\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name identifying the conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.name\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Name of Organization publishing this conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.publisher\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.telecom\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Human description of the conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this conformance statement (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conformance-definitions.html#Conformance.status\"><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 style=\"color: navy\" href=\"conformance-statement-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.experimental\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date when the conformance statement was published.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.date\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software\"><b>software</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> Software that is covered by this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Name software is known by.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.name\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version identifier for the software covered by this statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.version\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date this version of the software released.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.releaseDate\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </software>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation\"><b>implementation</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If this describes a specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Information about the specific installation that this conformance statement relates to.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.description\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.url\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </implementation>\r\n <<a title=\"The version of the FHIR specification on which this conformance statement is based.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.fhirVersion\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag that indicates whether the application accepts unknown elements as part of a resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.acceptUnknown\"><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 title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the formats supported by this implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.format\"><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 style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">formats supported (xml | json | mime type)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.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>\r\n <<a title=\"A definition of the restful capabilities of the solution, if any.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest\"><b>rest</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If the endpoint is a RESTful one --></span>\r\n <<a title=\"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.mode\"><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 style=\"color: navy\" href=\"restful-conformance-mode.html\">client | server</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the system's restful capabilities that apply across all applications, such as security.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentation\"><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>\r\n <<a title=\"Information about security of implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security\"><b>security</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Information about security of implementation --></span>\r\n <<a title=\"Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.cors\"><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>\r\n <<a title=\"Types of security services are supported/required by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.service\"><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 style=\"color: navy\" href=\"restful-security-service.html\">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style=\"color: Gray\"> --></span></service>\r\n <<a title=\"General description of how security works.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.description\"><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>\r\n <<a title=\"Certificates associated with security profiles.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate\"><b>certificate</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Certificates associated with security profiles --></span>\r\n <<a title=\"Mime type for certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.type\"><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 style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type for certificate</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Actual certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.blob\"><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>\r\n </certificate>\r\n </security>\r\n <<a title=\"A specification of the restful capabilities of the solution for a specific resource type.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource\"><b>resource</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Resource served on the REST interface --></span>\r\n <<a title=\"A type of resource exposed via the restful interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.type\"><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 style=\"color: navy\" href=\"resource-types.html\">A resource type that is supported</a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.profile\"><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>\r\n <<a title=\"Identifies a restful operation supported by the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> What operations are supported? --></span>\r\n <<a title=\"Coded identifier of the operation, supported by the system resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.code\"><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 style=\"color: navy\" href=\"type-restful-operation.html\">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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'.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.documentation\"><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>\r\n </operation>\r\n <<a title=\"A flag for whether the server is able to return past versions as part of the vRead operation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.readHistory\"><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>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.updateCreate\"><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>\r\n <<a title=\"A list of _include values supported by the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchInclude\"><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>\r\n <<a title=\"Additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam\"><b>searchParam</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Additional search params defined --></span>\r\n <<a title=\"The name of the search parameter used in the interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.name\"><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>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.definition\"><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>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.type\"><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 style=\"color: navy\" href=\"search-param-type.html\">number | date | string | token | reference | composite | quantity</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.documentation\"><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>\r\n <<a title=\"Types of resource (if a resource is referenced).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.target\"><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 style=\"color: navy\" href=\"resource-types.html\">Types of resource (if a resource reference)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Chained names supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.chain\"><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>\r\n </searchParam>\r\n </resource>\r\n <<a title=\"A specification of restful operations supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What operations are supported? --></span>\r\n <<a title=\"A coded identifier of the operation, supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.code\"><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 style=\"color: navy\" href=\"system-restful-operation.html\">transaction | search-system | history-system</a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.documentation\"><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>\r\n </operation>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query\"><b>query</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of a named query --></span>\r\n <<a title=\"The name of a query, which is used in the _query parameter when the query is called.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.name\"><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>\r\n <<a title=\"Identifies the custom query, defined either in FHIR core or another profile.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.definition\"><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>\r\n <<a title=\"Additional information about how the query functions in this particular implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.documentation\"><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>\r\n <<a title=\"Identifies which of the parameters for the named query are supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.parameter\"><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>\r\n </query>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentMailbox\"><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>\r\n </rest>\r\n <<a title=\"A description of the messaging capabilities of the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging\"><b>messaging</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If messaging is supported --></span>\r\n <<a title=\"An address to which messages and/or replies are to be sent.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Actual endpoint being described</span><span style=\"color: Gray\"> --></span>\r\n <<a 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).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.reliableCache\"><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>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.documentation\"><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>\r\n <<a title=\"A description of the solution's support for an event at this end point.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Declare support for this event --></span>\r\n <<a title=\"A coded identifier of a supported messaging event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.code\"><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 style=\"color: navy\" href=\"message-events.html\">Event type</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The impact of the content of the message.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.category\"><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 style=\"color: navy\" href=\"message-significance-category.html\">Consequence | Currency | Notification</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.mode\"><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 style=\"color: navy\" href=\"message-conformance-event-mode.html\">sender | receiver</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the messaging transport protocol(s) identifiers, supported by this endpoint.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.protocol\"><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 style=\"color: navy\" href=\"message-transport.html\">http | ftp | mllp +</a></span><span style=\"color: Gray\"> --></span></protocol>\r\n <<a title=\"A resource associated with the event. This is the resource that defines the event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.focus\"><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 style=\"color: navy\" href=\"resource-types.html\">Resource that's focus of message</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the request for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.request\"><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>\r\n <<a title=\"Information about the response for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.response\"><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>\r\n <<a title=\"Guidance on how this event is handled, such as internal system trigger points, business rules, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.documentation\"><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>\r\n </event>\r\n </messaging>\r\n <<a title=\"A document definition.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document\"><b>document</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Document definition --></span>\r\n <<a title=\"Mode of this document declaration - whether application is producer or consumer.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.mode\"><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 style=\"color: navy\" href=\"document-mode.html\">producer | consumer</a></span><span style=\"color: Gray\"> --></span>\r\n <<a 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.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.documentation\"><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>\r\n <<a title=\"A constraint on a resource used in the document.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.profile\"><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>\r\n </document>\r\n</Conformance>\r\n</pre></div>" }, "name": "conformance", "publisher": "FHIR Project", "description": "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": "draft", "date": "2014-09-30", "requirements": "Scope and Usage Conformance statements are used in one of three ways: \r\n\r\nDescribe 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. \r\n\r\nThis 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. \r\n\r\nA conformance statement is identified as being an implementation statement through the presence of the implementation element. \r\n\r\nDescribe 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. \r\n\r\nThis 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. \r\n\r\nA conformance statement is identified as being a software solution statement through the presence of the software element. \r\n\r\nDescribe 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. \r\n\r\nA conformance statement is identified as being a requirements statement through the presence of the proposal element. \r\n\r\n\r\n\r\nThese 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": "Conformance", "publish": true, "element": [ { "path": "Conformance", "definition": { "short": "A conformance statement", "formal": "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": 1, "max": "1", "type": [ { "code": "Resource" } ], "constraint": [ { "key": "2", "name": "Details", "severity": "error", "human": "A Conformance statement SHALL have at least one of description, software, or implementation", "xpath": "count(f:software | f:implementation | f:description) > 0" }, { "key": "1", "name": "Content Required", "severity": "error", "human": "A Conformance statement SHALL have at least one of rest, messaging or document", "xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)" }, { "key": "7", "name": "Document unique", "severity": "error", "human": "The set of documents must be unique by the combination of profile & mode", "xpath": "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))" }, { "key": "5", "name": "Messaging endpoints unique", "severity": "error", "human": "The set of end points listed for messaging must be unique", "xpath": "count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))" }, { "key": "4", "name": "End point populated when multiple", "severity": "error", "human": "If there is more than one messaging element, endpoint must be specified for each one", "xpath": "count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])" }, { "key": "8", "name": "Rest unique by mode", "severity": "error", "human": "There can only be one REST declaration per mode", "xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))" } ], "isModifier": false } }, { "path": "Conformance.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.text", "definition": { "short": "Text summary of the resource, for human interpretation", "formal": "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": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "synonym": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "isModifier": false } }, { "path": "Conformance.contained", "definition": { "short": "Contained, inline Resources", "formal": "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": "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": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "isModifier": false } }, { "path": "Conformance.identifier", "definition": { "short": "Logical id to reference this statement", "formal": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.version", "definition": { "short": "Logical id for this version of the statement", "formal": "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": "There may be multiple different instances of a conformance statement that have the same identifier but different versions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.name", "definition": { "short": "Informal name for this conformance statement", "formal": "A free text natural language name identifying the conformance statement.", "comments": "The name is not expected to be globally unique.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.publisher", "definition": { "short": "Publishing Organization", "formal": "Name of Organization publishing this conformance statement.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.telecom", "definition": { "short": "Contacts for Organization", "formal": "Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc.", "min": 0, "max": "*", "type": [ { "code": "Contact" } ], "isModifier": false } }, { "path": "Conformance.description", "definition": { "short": "Human description of the conformance statement", "formal": "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": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.status", "definition": { "short": "draft | active | retired", "formal": "The status of this conformance statement.", "comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "ConformanceStatementStatus", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/conformance-statement-status" } } } }, { "path": "Conformance.experimental", "definition": { "short": "If for testing purposes, not real usage", "formal": "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": "Allows filtering of conformance statements that are appropriate for use vs. not.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": false } }, { "path": "Conformance.date", "definition": { "short": "Publication Date", "formal": "The date when the conformance statement was published.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ], "isModifier": false } }, { "path": "Conformance.software", "definition": { "short": "Software that is covered by this conformance statement", "formal": "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": 0, "max": "1", "isModifier": false } }, { "path": "Conformance.software.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.software.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.software.name", "definition": { "short": "A name the software is known by", "formal": "Name software is known by.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.software.version", "definition": { "short": "Version covered by this statement", "formal": "The version identifier for the software covered by this statement.", "comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.software.releaseDate", "definition": { "short": "Date this version released", "formal": "Date this version of the software released.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isModifier": false } }, { "path": "Conformance.implementation", "definition": { "short": "If this describes a specific instance", "formal": "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": 0, "max": "1", "isModifier": false } }, { "path": "Conformance.implementation.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.implementation.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.implementation.description", "definition": { "short": "Describes this specific instance", "formal": "Information about the specific installation that this conformance statement relates to.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.implementation.url", "definition": { "short": "Base URL for the installation", "formal": "A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": false } }, { "path": "Conformance.fhirVersion", "definition": { "short": "FHIR Version", "formal": "The version of the FHIR specification on which this conformance statement is based.", "min": 1, "max": "1", "type": [ { "code": "id" } ], "isModifier": false } }, { "path": "Conformance.acceptUnknown", "definition": { "short": "True if application accepts unknown elements", "formal": "A flag that indicates whether the application accepts unknown elements as part of a resource.", "comments": "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": 1, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": false } }, { "path": "Conformance.format", "definition": { "short": "formats supported (xml | json | mime type)", "formal": "A list of the formats supported by this implementation.", "comments": "\"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": 1, "max": "*", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "MimeType", "isExtensible": false, "conformance": "required", "referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } }, { "path": "Conformance.profile", "definition": { "short": "Profiles supported by the system", "formal": "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": "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).\n\nTypical 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": 0, "max": "*", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Profile" } ], "isModifier": false } }, { "path": "Conformance.rest", "definition": { "short": "If the endpoint is a RESTful one", "formal": "A definition of the restful capabilities of the solution, if any.", "comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).", "min": 0, "max": "*", "constraint": [ { "key": "10", "name": "Query unique in rest mode", "severity": "error", "human": "A given query can only be described once per RESTful mode", "xpath": "count(f:query)=count(distinct-values(f:query/f:name/@value))" }, { "key": "9", "name": "Resource unique in rest mode", "severity": "error", "human": "A given resource can only be described once per RESTful mode", "xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))" } ], "isModifier": false } }, { "path": "Conformance.rest.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.mode", "definition": { "short": "client | server", "formal": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "RestfulConformanceMode", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/restful-conformance-mode" } } } }, { "path": "Conformance.rest.documentation", "definition": { "short": "General description of implementation", "formal": "Information about the system's restful capabilities that apply across all applications, such as security.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.security", "definition": { "short": "Information about security of implementation", "formal": "Information about security of implementation.", "min": 0, "max": "1", "isModifier": false } }, { "path": "Conformance.rest.security.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.security.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.security.cors", "definition": { "short": "Adds CORS Headers (http://enable-cors.org/)", "formal": "Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server.", "comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": false } }, { "path": "Conformance.rest.security.service", "definition": { "short": "OAuth | OAuth2 | NTLM | Basic | Kerberos", "formal": "Types of security services are supported/required by the system.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "binding": { "name": "RestfulSecurityService", "isExtensible": true, "conformance": "preferred", "referenceResource": { "reference": "http://hl7.org/fhir/vs/restful-security-service" } } } }, { "path": "Conformance.rest.security.description", "definition": { "short": "General description of how security works", "formal": "General description of how security works.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.security.certificate", "definition": { "short": "Certificates associated with security profiles", "formal": "Certificates associated with security profiles.", "min": 0, "max": "*", "isModifier": false } }, { "path": "Conformance.rest.security.certificate.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.security.certificate.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.security.certificate.type", "definition": { "short": "Mime type for certificate", "formal": "Mime type for certificate.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "MimeType", "isExtensible": false, "conformance": "required", "referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt" } } }, { "path": "Conformance.rest.security.certificate.blob", "definition": { "short": "Actual certificate", "formal": "Actual certificate.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" } ], "isModifier": false } }, { "path": "Conformance.rest.resource", "definition": { "short": "Resource served on the REST interface", "formal": "A specification of the restful capabilities of the solution for a specific resource type.", "comments": "Max of one repetition per resource type.", "min": 1, "max": "*", "constraint": [ { "key": "11", "name": "Operation unique in resource", "severity": "error", "human": "Operation codes must be unique in the context of a resource", "xpath": "count(f:operation)=count(distinct-values(f:operation/f:code/@value))" }, { "key": "12", "name": "SearchParam unique in resource", "severity": "error", "human": "Search parameter names must be unique in the context of a resource", "xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.type", "definition": { "short": "A resource type that is supported", "formal": "A type of resource exposed via the restful interface.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "ResourceType", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/resource-types" } } } }, { "path": "Conformance.rest.resource.profile", "definition": { "short": "What structural features are supported", "formal": "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": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.", "min": 0, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Profile" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.operation", "definition": { "short": "What operations are supported?", "formal": "Identifies a restful operation supported by the solution.", "min": 1, "max": "*", "isModifier": false } }, { "path": "Conformance.rest.resource.operation.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.operation.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.operation.code", "definition": { "short": "read | vread | update | delete | history-instance | validate | history-type | create | search-type", "formal": "Coded identifier of the operation, supported by the system resource.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "RestfulOperationType", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/type-restful-operation" } } } }, { "path": "Conformance.rest.resource.operation.documentation", "definition": { "short": "Anything special about operation behavior", "formal": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.readHistory", "definition": { "short": "Whether vRead can return past versions", "formal": "A flag for whether the server is able to return past versions as part of the vRead operation.", "comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.updateCreate", "definition": { "short": "If allows/uses update to a new location", "formal": "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": "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": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchInclude", "definition": { "short": "_include values supported by the server", "formal": "A list of _include values supported by the server.", "comments": "If this list is empty, the server does not support includes.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam", "definition": { "short": "Additional search params defined", "formal": "Additional search parameters for implementations to support and/or make use of.", "min": 0, "max": "*", "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.name", "definition": { "short": "Name of search parameter", "formal": "The name of the search parameter used in the interface.", "comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.definition", "definition": { "short": "Source of definition for parameter", "formal": "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": "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": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.type", "definition": { "short": "number | date | string | token | reference | composite | quantity", "formal": "The type of value a search parameter refers to, and how the content is interpreted.", "comments": "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": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "SearchParamType", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/search-param-type" } } } }, { "path": "Conformance.rest.resource.searchParam.documentation", "definition": { "short": "Server-specific usage", "formal": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.resource.searchParam.target", "definition": { "short": "Types of resource (if a resource reference)", "formal": "Types of resource (if a resource is referenced).", "comments": "This SHALL be the same as or a proper subset of the resources listed in the search parameter definition.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "ResourceType", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/resource-types" } } } }, { "path": "Conformance.rest.resource.searchParam.chain", "definition": { "short": "Chained names supported", "formal": "Chained names supported.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.operation", "definition": { "short": "What operations are supported?", "formal": "A specification of restful operations supported by the system.", "min": 0, "max": "*", "isModifier": false } }, { "path": "Conformance.rest.operation.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.operation.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.operation.code", "definition": { "short": "transaction | search-system | history-system", "formal": "A coded identifier of the operation, supported by the system.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "RestfulOperationSystem", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/system-restful-operation" } } } }, { "path": "Conformance.rest.operation.documentation", "definition": { "short": "Anything special about operation behavior", "formal": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.query", "definition": { "short": "Definition of a named query", "formal": "Definition of a named query and its parameters and their meaning.", "min": 0, "max": "*", "constraint": [ { "key": "13", "name": "SearchParam unique in query", "severity": "error", "human": "Search parameter names must be unique in the context of a query", "xpath": "count(f:parameter)=count(distinct-values(f:parameter/f:name/@value))" } ], "isModifier": false } }, { "path": "Conformance.rest.query.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.query.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.rest.query.name", "definition": { "short": "Special named queries (_query=)", "formal": "The name of a query, which is used in the _query parameter when the query is called.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.query.definition", "definition": { "short": "Where query is defined", "formal": "Identifies the custom query, defined either in FHIR core or another profile.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "isModifier": false } }, { "path": "Conformance.rest.query.documentation", "definition": { "short": "Additional usage guidance", "formal": "Additional information about how the query functions in this particular implementation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.rest.query.parameter", "definition": { "short": "Parameter for the named query", "formal": "Identifies which of the parameters for the named query are supported.", "comments": "This SHALL be a proper subset of the parameters defined on the query definition.", "min": 0, "max": "*", "nameReference": "Conformance.rest.resource.searchParam", "isModifier": false } }, { "path": "Conformance.rest.documentMailbox", "definition": { "short": "How documents are accepted in /Mailbox", "formal": "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": "If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "isModifier": false } }, { "path": "Conformance.messaging", "definition": { "short": "If messaging is supported", "formal": "A description of the messaging capabilities of the solution.", "comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.", "min": 0, "max": "*", "constraint": [ { "key": "3", "name": "End points for Implementations", "severity": "error", "human": "Messaging end point is required (and is only permitted) when statement is for an implementation", "xpath": "exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)" }, { "key": "6", "name": "Event unique", "severity": "error", "human": "The set of events per messaging endpoint must be unique by the combination of code & mode", "xpath": "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))" } ], "isModifier": false } }, { "path": "Conformance.messaging.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.messaging.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.messaging.endpoint", "definition": { "short": "Actual endpoint being described", "formal": "An address to which messages and/or replies are to be sent.", "comments": "For solutions that do not use network addresses for routing, it can be just an identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": false } }, { "path": "Conformance.messaging.reliableCache", "definition": { "short": "Reliable Message Cache Length", "formal": "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": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isModifier": false } }, { "path": "Conformance.messaging.documentation", "definition": { "short": "Messaging interface behavior details", "formal": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.messaging.event", "definition": { "short": "Declare support for this event", "formal": "A description of the solution's support for an event at this end point.", "comments": "The same event may be listed up to two times - once as sender and once as receiver.", "min": 1, "max": "*", "isModifier": false } }, { "path": "Conformance.messaging.event.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.messaging.event.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.messaging.event.code", "definition": { "short": "Event type", "formal": "A coded identifier of a supported messaging event.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isModifier": false, "binding": { "name": "MessageEvent", "isExtensible": true, "conformance": "preferred", "referenceResource": { "reference": "http://hl7.org/fhir/message-events" } } } }, { "path": "Conformance.messaging.event.category", "definition": { "short": "Consequence | Currency | Notification", "formal": "The impact of the content of the message.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "MessageSignificanceCategory", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/message-significance-category" } } } }, { "path": "Conformance.messaging.event.mode", "definition": { "short": "sender | receiver", "formal": "The mode of this event declaration - whether application is sender or receiver.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "ConformanceEventMode", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/message-conformance-event-mode" } } } }, { "path": "Conformance.messaging.event.protocol", "definition": { "short": "http | ftp | mllp +", "formal": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.", "min": 0, "max": "*", "type": [ { "code": "Coding" } ], "isModifier": false, "binding": { "name": "MessageTransport", "isExtensible": true, "conformance": "preferred", "referenceResource": { "reference": "http://hl7.org/fhir/vs/message-transport" } } } }, { "path": "Conformance.messaging.event.focus", "definition": { "short": "Resource that's focus of message", "formal": "A resource associated with the event. This is the resource that defines the event.", "comments": "This SHALL be provided if the event type supports multiple different resource types.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "ResourceType", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/resource-types" } } } }, { "path": "Conformance.messaging.event.request", "definition": { "short": "Profile that describes the request", "formal": "Information about the request for this event.", "min": 1, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Profile" } ], "isModifier": false } }, { "path": "Conformance.messaging.event.response", "definition": { "short": "Profile that describes the response", "formal": "Information about the response for this event.", "min": 1, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Profile" } ], "isModifier": false } }, { "path": "Conformance.messaging.event.documentation", "definition": { "short": "Endpoint-specific event documentation", "formal": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.document", "definition": { "short": "Document definition", "formal": "A document definition.", "min": 0, "max": "*", "isModifier": false } }, { "path": "Conformance.document.extension", "definition": { "short": "Additional Content defined by implementations", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.document.modifierExtension", "definition": { "short": "Extensions that cannot be ignored", "formal": "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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false } }, { "path": "Conformance.document.mode", "definition": { "short": "producer | consumer", "formal": "Mode of this document declaration - whether application is producer or consumer.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": false, "binding": { "name": "DocumentMode", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/document-mode" } } } }, { "path": "Conformance.document.documentation", "definition": { "short": "Description of document support", "formal": "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": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false } }, { "path": "Conformance.document.profile", "definition": { "short": "Constraint on a resource used in the document", "formal": "A constraint on a resource used in the document.", "comments": "The first resource is the document resource.", "min": 1, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Profile" } ], "isModifier": false } } ], "searchParam": [ { "name": "_id", "type": "token", "documentation": "The logical resource id associated with the resource (must be supported by all servers)" }, { "name": "_language", "type": "token", "documentation": "The language of the resource" }, { "name": "date", "type": "date", "documentation": "The conformance statement publication date", "xpath": "f:Conformance/f:date" }, { "name": "description", "type": "string", "documentation": "Text search in the description of the conformance statement", "xpath": "f:Conformance/f:description" }, { "name": "event", "type": "token", "documentation": "Event code in a conformance statement", "xpath": "f:Conformance/f:messaging/f:event/f:code" }, { "name": "fhirversion", "type": "token", "documentation": "The version of FHIR", "xpath": "f:Conformance/f:version" }, { "name": "format", "type": "token", "documentation": "formats supported (xml | json | mime type)", "xpath": "f:Conformance/f:format" }, { "name": "identifier", "type": "token", "documentation": "The identifier of the conformance statement", "xpath": "f:Conformance/f:identifier" }, { "name": "mode", "type": "token", "documentation": "Mode - restful (server/client) or messaging (sender/receiver)", "xpath": "f:Conformance/f:rest/f:mode" }, { "name": "name", "type": "string", "documentation": "Name of the conformance statement", "xpath": "f:Conformance/f:name" }, { "name": "profile", "type": "reference", "documentation": "A profile id invoked in a conformance statement", "xpath": "f:Conformance/f:rest/f:resource/f:profile" }, { "name": "publisher", "type": "string", "documentation": "Name of the publisher of the conformance statement", "xpath": "f:Conformance/f:publisher" }, { "name": "resource", "type": "token", "documentation": "Name of a resource mentioned in a conformance statement", "xpath": "f:Conformance/f:rest/f:resource/f:type" }, { "name": "security", "type": "token", "documentation": "Information about security of implementation", "xpath": "f:Conformance/f:rest/f:security" }, { "name": "software", "type": "string", "documentation": "Part of a the name of a software application", "xpath": "f:Conformance/f:software/f:name" }, { "name": "status", "type": "token", "documentation": "The current status of the conformance statement", "xpath": "f:Conformance/f:status" }, { "name": "supported-profile", "type": "reference", "documentation": "Profiles supported by the system", "xpath": "f:Conformance/f:profile" }, { "name": "version", "type": "token", "documentation": "The version identifier of the conformance statement", "xpath": "f:Conformance/f:version" } ] } ] }