This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
|
|
Compartments
|
A conformance statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
The conformance statement is a key part of the overall conformance framework in FHIR. It is used as a statement of the features of actual software, or of a set of rules for an application to conform to. This statement connects to all the detailed statements of functionality, such as
StructureDefinitions
and
and
ValueSets
.
This
composite
statement
of
application
functionality
is
used
as
either
the
source
or
target
of
a
conformance
assessment.
For
further
information
about
Conformance
testing,
see
Conformance
Rules
and
Profiling
FHIR
.
Specifically,
conformance
statements
are
used
in
one
of
three
ways:
. This composite statement of application functionality is used as either the source or target of a conformance assessment. For further information about Conformance testing, see
Conformance Rules
and
Profiling FHIR
.
Specifically, conformance statements are used in one of three ways:
In this scenario, the conformance statement describes the capabilities of a deployed and configured solution available at a particular access point or set of access points. The statement describes exactly how to interface with that deployed solution and thus provides for a degree of self-configuration of software solutions.
This is the type of profile that FHIR restful solutions are expected to make available on invocation of the
conformance
operation.
It
is
also
the
type
of
statement
that
forms
a
basis
for
the
testing,
certification
or
commissioning
of
specific
software
installations.
operation. It is also the type of statement that forms a basis for the testing, certification or commissioning of specific software installations.
In this scenario, the conformance statement describes generic capabilities of a software application or component solution. The solution might be available for purchase or other acquisition and might be deployed and configured at any number of independent sites. Because it is not dependent on any particular implementation, the profile cannot provide specific details such as endpoint addresses. It may also need to document various configurations in which the application can be set up or describe the degree of customizability associated with the solution.
This type of statement may be used as a marketing tool by software and system developers to formally describe their capabilities. It can also be used as the basis for conformance testing of software solutions independent of a particular installation.
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.
These three types of profiles can be used together. A requirements statement can be compared against the solution statements proffered by respondents to an RFP. A solution statement for a software package forms the starting point for the implementation statement associated with a particular installation of that software package.
Conformance Statements provide for a degree of automatic configuration and adaptation. However, capturing absolutely every variation that could impact the interoperability of two systems, let alone keeping that detailed information up-to-date as systems evolve through maintenance and upgrades is rarely practical. Therefore, conformance statements should be seen as an interim step. They provide a degree of automation. However, they also provide a great deal of human-readable content that can minimize the need for direct communication between the operators of the systems being configured to interoperate.
This resource is referenced by testscript
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
Σ | 0..1 | uri |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
|
|
code |
ConformanceResourceStatus |
|
Σ | 0..1 | boolean |
|
|
Σ | 1..1 | dateTime | Publication Date(/time) |
![]() ![]() | Σ | 0..1 | string |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..* | ContactPoint |
|
|
|
|
|
|
|
Σ
|
|
|
Context of Use ValueSet ( Extensible ) |
|
0..1 | string |
|
|
|
0..1 | string |
|
|
|
Σ | 1..1 | code |
ConformanceStatementKind |
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | dateTime |
|
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | string |
|
|
Σ | 0..1 | uri |
|
|
Σ | 1..1 | id |
|
|
Σ | 1..1 | code |
UnknownContentCode |
|
Σ | 1..* | code |
|
|
0..* | Reference ( StructureDefinition ) |
|
|
|
|
0..* | BackboneElement |
|
|
Σ | 1..1 | code |
RestfulConformanceMode |
|
0..1 | string |
|
|
|
0..1 | BackboneElement |
|
|
|
0..1 | boolean |
|
|
|
0..* | CodeableConcept |
RestfulSecurityService |
|
|
0..1 | string |
|
|
|
0..* | BackboneElement |
|
|
|
0..1 | code |
|
|
|
0..1 | base64Binary |
|
|
|
|
|
BackboneElement |
|
|
Σ | 1..1 | code |
ResourceType |
|
0..1 | Reference ( StructureDefinition ) |
|
|
|
1..* | BackboneElement |
|
|
|
1..1 | code |
TypeRestfulInteraction |
|
|
0..1 | string |
|
|
|
0..1 | code |
ResourceVersionPolicy |
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | code |
ConditionalDeleteStatus |
|
|
0..* | string |
|
|
|
0..* | string |
|
|
|
I | 0..* | BackboneElement |
|
|
1..1 | string |
|
|
|
0..1 | uri |
|
|
|
1..1 | code |
SearchParamType |
|
|
0..1 | string |
|
|
|
0..* | code |
ResourceType |
|
|
0..* | code |
SearchModifierCode |
|
|
0..* | string |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | code |
SystemRestfulInteraction |
|
|
0..1 | string |
|
|
|
0..1 | code |
TransactionMode |
|
|
0..* |
|
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | string |
|
|
|
1..1 | Reference ( OperationDefinition ) |
|
|
|
0..* | uri |
|
|
|
I | 0..* | BackboneElement |
|
|
0..* | BackboneElement |
|
|
|
1..1 | Coding |
MessageTransport |
|
|
1..1 | uri |
|
|
|
0..1 | unsignedInt |
|
|
|
0..1 | string |
|
|
|
1..* | BackboneElement |
|
|
|
1..1 | Coding |
MessageEvent |
|
|
0..1 | code |
MessageSignificanceCategory |
|
|
1..1 | code |
ConformanceEventMode |
|
|
1..1 | code |
ResourceType |
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
|
0..1 | string |
|
|
|
I | 0..* | BackboneElement |
|
|
1..1 | code |
DocumentMode |
|
|
0..1 | string |
|
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<Conformance xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical uri to reference this statement --> <version value="[string]"/><!-- 0..1 Logical id for this version of the statement --> <name value="[string]"/><!-- 0..1 Informal name for this conformance statement -->
<<status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --><<name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact><<description value="[string]"/><!--0..1 Human description of the conformance statement -->
<<useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[string]"/><!-- 0..1 Why this resource has been created --> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <kind value="[code]"/><!-- 1..1 instance | capability | requirements --> <software> <!--0..1 Software that is covered by this conformance statement --> <name value="[string]"/><!-- 1..1 A name the software is known by --> <version value="[string]"/><!-- 0..1 Version covered by this statement --> <releaseDate value="[dateTime]"/><!-- 0..1 Date this version released --> </software> <implementation> <!--
0..1 If this describes a specific instance --> <description value="[string]"/><!-- 1..1 Describes this specific instance --> <url value="[uri]"/><!-- 0..1 Base URL for the installation --> </implementation> <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses --> <acceptUnknown value="[code]"/><!-- 1..1 no | extensions | elements | both --> <format value="[code]"/><!-- 1..* formats supported (xml | json | mime type)
--> <profile><!-- 0..* Reference(StructureDefinition) Profiles for use cases supported --></profile> <rest> <!--
0..* If the endpoint is a RESTful one --> <mode value="[code]"/><!-- 1..1 client | server --> <documentation value="[string]"/><!-- 0..1 General description of implementation --> <security> <!-- 0..1 Information about security of implementation --> <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) --> <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service> <description value="[string]"/><!-- 0..1 General description of how security works --> <certificate> <!-- 0..* Certificates associated with security profiles --> <type value="[code]"/><!-- 0..1 Mime type for certificate
--> <blob value="[base64Binary]"/><!-- 0..1 Actual certificate --> </certificate> </security>
<<resource> <!-- 0..* Resource served on the REST interface --> <type value="[code]"/><!-- 1..1 A resource type that is supported --> <profile><!-- 0..1 Reference(StructureDefinition) Base System profile for all uses of resource --></profile> <interaction> <!-- 1..* What operations are supported? --><<code value="[code]"/><!-- 1..1 read | vread | update | delete | history-instance | history-type | create | search-type --> <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update --> <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions --> <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity --> <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create --> <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update --> <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported --> <searchInclude value="[string]"/><!-- 0..* _include values supported by the server --> <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server --> <searchParam> <!-- 0..* Search params supported by implementation --> <name value="[string]"/><!-- 1..1 Name of search parameter --> <definition value="[uri]"/><!-- 0..1 Source of definition for parameter --> <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri --> <documentation value="[string]"/><!-- 0..1 Server-specific usage --> <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) --> <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type --> <chain value="[string]"/><!-- 0..* Chained names supported --> </searchParam> </resource> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 transaction | search-system | history-system --> <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <transactionMode value="[code]"/><!-- 0..1 not-supported | batch | transaction | both --> <searchParam><!-- 0..* Content as for Conformance.rest.resource.searchParam Search params for searching all resources --></searchParam> <operation> <!-- 0..* Definition of an operation or a custom query --><<name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked --> <definition><!-- 1..1 Reference(OperationDefinition) The defined operation/query --></definition> </operation><<compartment value="[uri]"/><!-- 0..* Compartments served/used by system --> </rest> <messaging> <!--0..* If messaging is supported -->
<<endpoint> <!-- 0..* Where messages should be sent --> <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol> <address value="[uri]"/><!-- 1..1 Address of end-point --> </endpoint> <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) --> <documentation value="[string]"/><!-- 0..1 Messaging interface behavior details --> <event> <!-- 1..* Declare support for this event --> <code><!-- 1..1 Coding Event type --></code> <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification --> <mode value="[code]"/><!-- 1..1 sender | receiver --> <focus value="[code]"/><!-- 1..1 Resource that's focus of message --> <request><!-- 1..1 Reference(StructureDefinition) Profile that describes the request --></request> <response><!-- 1..1 Reference(StructureDefinition) Profile that describes the response --></response> <documentation value="[string]"/><!-- 0..1 Endpoint-specific event documentation --> </event> </messaging> <document> <!--0..* Document definition --> <mode value="[code]"/><!-- 1..1 producer | consumer --> <documentation value="[string]"/><!-- 0..1 Description of document support --> <profile><!-- 1..1 Reference(StructureDefinition) Constraint on a resource used in the document --></profile> </document> </Conformance>
JSON
Template
JSON Template
{
"resourceType" : "Conformance",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical uri to reference this statement
"version" : "<string>", // Logical id for this version of the statement
"name" : "<string>", // Informal name for this conformance statement
"
"status" : "<code>", // R! draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"date" : "<dateTime>", // R! Publication Date(/time)
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"description" : "<string>", // C? Human description of the conformance statement
"
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<string>", // Why this resource has been created
"copyright" : "<string>", // Use and/or publishing restrictions
"kind" : "<code>", // R! instance | capability | requirements
"software" : { // C? Software that is covered by this conformance statement
"name" : "<string>", // R! A name the software is known by
"version" : "<string>", // Version covered by this statement
"releaseDate" : "<dateTime>" // Date this version released
},
"implementation" : { // C? If this describes a specific instance
"description" : "<string>", // R! Describes this specific instance
"url" : "<uri>" // Base URL for the installation
},
"fhirVersion" : "<id>", // R! FHIR Version the system uses
"acceptUnknown" : "<code>", // R! no | extensions | elements | both
"format" : ["<code>"], // R! formats supported (xml | json | mime type)
"profile" : [{ Reference(StructureDefinition) }], // Profiles for use cases supported
"rest" : [{ // C? If the endpoint is a RESTful one
"mode" : "<code>", // R! client | server
"documentation" : "<string>", // General description of implementation
"security" : { // Information about security of implementation
"cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/)
"service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
"description" : "<string>", // General description of how security works
"certificate" : [{ // Certificates associated with security profiles
"type" : "<code>", // Mime type for certificate
"blob" : "<base64Binary>" // Actual certificate
}]
},
"
"resource" : [{ // Resource served on the REST interface
"type" : "<code>", // R! A resource type that is supported
"profile" : { Reference(StructureDefinition) }, // Base System profile for all uses of resource
"interaction" : [{ // R! What operations are supported?
"
"code" : "<code>", // R! read | vread | update | delete | history-instance | history-type | create | search-type
"documentation" : "<string>" // Anything special about operation behavior
}],
"versioning" : "<code>", // no-version | versioned | versioned-update
"readHistory" : <boolean>, // Whether vRead can return past versions
"updateCreate" : <boolean>, // If update can commit to a new identity
"conditionalCreate" : <boolean>, // If allows/uses conditional create
"conditionalUpdate" : <boolean>, // If allows/uses conditional update
"conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
"searchInclude" : ["<string>"], // _include values supported by the server
"searchRevInclude" : ["<string>"], // _revinclude values supported by the server
"searchParam" : [{ // Search params supported by implementation
"name" : "<string>", // R! Name of search parameter
"definition" : "<uri>", // Source of definition for parameter
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri
"documentation" : "<string>", // Server-specific usage
"target" : ["<code>"], // Types of resource (if a resource reference)
"modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type
"chain" : ["<string>"] // Chained names supported
}]
}],
"interaction" : [{ // What operations are supported?
"code" : "<code>", // R! transaction | search-system | history-system
"documentation" : "<string>" // Anything special about operation behavior
}],
"transactionMode" : "<code>", // not-supported | batch | transaction | both
"searchParam" : [{ Content as for Conformance.rest.resource.searchParam }], // Search params for searching all resources
"operation" : [{ // Definition of an operation or a custom query
"
"name" : "<string>", // R! Name by which the operation/query is invoked
"definition" : { Reference(OperationDefinition) } // R! The defined operation/query
}],
"
"compartment" : ["<uri>"] // Compartments served/used by system
}],
"messaging" : [{ // C? If messaging is supported
"
"endpoint" : [{ // Where messages should be sent
"protocol" : { Coding }, // R! http | ftp | mllp +
"address" : "<uri>" // R! Address of end-point
}],
"reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
"documentation" : "<string>", // Messaging interface behavior details
"event" : [{ // R! Declare support for this event
"code" : { Coding }, // R! Event type
"category" : "<code>", // Consequence | Currency | Notification
"mode" : "<code>", // R! sender | receiver
"focus" : "<code>", // R! Resource that's focus of message
"request" : { Reference(StructureDefinition) }, // R! Profile that describes the request
"response" : { Reference(StructureDefinition) }, // R! Profile that describes the response
"documentation" : "<string>" // Endpoint-specific event documentation
}]
}],
"document" : [{ // C? Document definition
"mode" : "<code>", // R! producer | consumer
"documentation" : "<string>", // Description of document support
"profile" : { Reference(StructureDefinition) } // R! Constraint on a resource used in the document
}]
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
Σ | 0..1 | uri |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
|
|
code |
ConformanceResourceStatus |
|
Σ | 0..1 | boolean |
|
|
Σ | 1..1 | dateTime | Publication Date(/time) |
![]() ![]() |
Σ | 0..1 | string |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..* | ContactPoint |
|
|
|
|
|
|
|
Σ
|
|
|
Context of Use ValueSet ( Extensible ) |
|
0..1 | string |
|
|
|
0..1 | string |
|
|
|
Σ | 1..1 | code |
ConformanceStatementKind |
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | dateTime |
|
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | string |
|
|
Σ | 0..1 | uri |
|
|
Σ | 1..1 | id |
|
|
Σ | 1..1 | code |
UnknownContentCode |
|
Σ | 1..* | code |
|
|
0..* | Reference ( StructureDefinition ) |
|
|
|
|
0..* | BackboneElement |
|
|
Σ | 1..1 | code |
RestfulConformanceMode |
|
0..1 | string |
|
|
|
0..1 | BackboneElement |
|
|
|
0..1 | boolean |
|
|
|
0..* | CodeableConcept |
RestfulSecurityService |
|
|
0..1 | string |
|
|
|
0..* | BackboneElement |
|
|
|
0..1 | code |
|
|
|
0..1 | base64Binary |
|
|
|
|
|
BackboneElement |
|
|
Σ | 1..1 | code |
ResourceType |
|
0..1 | Reference ( StructureDefinition ) |
|
|
|
1..* | BackboneElement |
|
|
|
1..1 | code |
TypeRestfulInteraction |
|
|
0..1 | string |
|
|
|
0..1 | code |
ResourceVersionPolicy |
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | boolean |
|
|
|
0..1 | code |
ConditionalDeleteStatus |
|
|
0..* | string |
|
|
|
0..* | string |
|
|
|
I | 0..* | BackboneElement |
|
|
1..1 | string |
|
|
|
0..1 | uri |
|
|
|
1..1 | code |
SearchParamType |
|
|
0..1 | string |
|
|
|
0..* | code |
ResourceType |
|
|
0..* | code |
SearchModifierCode |
|
|
0..* | string |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | code |
SystemRestfulInteraction |
|
|
0..1 | string |
|
|
|
0..1 | code |
TransactionMode |
|
|
0..* |
|
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | string |
|
|
|
1..1 | Reference ( OperationDefinition ) |
|
|
|
0..* | uri |
|
|
|
I | 0..* | BackboneElement |
|
|
0..* | BackboneElement |
|
|
|
1..1 | Coding |
MessageTransport |
|
|
1..1 | uri |
|
|
|
0..1 | unsignedInt |
|
|
|
0..1 | string |
|
|
|
1..* | BackboneElement |
|
|
|
1..1 | Coding |
MessageEvent |
|
|
0..1 | code |
MessageSignificanceCategory |
|
|
1..1 | code |
ConformanceEventMode |
|
|
1..1 | code |
ResourceType |
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
|
0..1 | string |
|
|
|
I | 0..* | BackboneElement |
|
|
1..1 | code |
DocumentMode |
|
|
0..1 | string |
|
|
|
1..1 | Reference ( StructureDefinition ) |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<Conformance xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical uri to reference this statement --> <version value="[string]"/><!-- 0..1 Logical id for this version of the statement --> <name value="[string]"/><!-- 0..1 Informal name for this conformance statement -->
<<status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --><<name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact><<description value="[string]"/><!--0..1 Human description of the conformance statement -->
<<useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[string]"/><!-- 0..1 Why this resource has been created --> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <kind value="[code]"/><!-- 1..1 instance | capability | requirements --> <software> <!--0..1 Software that is covered by this conformance statement --> <name value="[string]"/><!-- 1..1 A name the software is known by --> <version value="[string]"/><!-- 0..1 Version covered by this statement --> <releaseDate value="[dateTime]"/><!-- 0..1 Date this version released --> </software> <implementation> <!--
0..1 If this describes a specific instance --> <description value="[string]"/><!-- 1..1 Describes this specific instance --> <url value="[uri]"/><!-- 0..1 Base URL for the installation --> </implementation> <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses --> <acceptUnknown value="[code]"/><!-- 1..1 no | extensions | elements | both --> <format value="[code]"/><!-- 1..* formats supported (xml | json | mime type)
--> <profile><!-- 0..* Reference(StructureDefinition) Profiles for use cases supported --></profile> <rest> <!--
0..* If the endpoint is a RESTful one --> <mode value="[code]"/><!-- 1..1 client | server --> <documentation value="[string]"/><!-- 0..1 General description of implementation --> <security> <!-- 0..1 Information about security of implementation --> <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) --> <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service> <description value="[string]"/><!-- 0..1 General description of how security works --> <certificate> <!-- 0..* Certificates associated with security profiles --> <type value="[code]"/><!-- 0..1 Mime type for certificate
--> <blob value="[base64Binary]"/><!-- 0..1 Actual certificate --> </certificate> </security>
<<resource> <!-- 0..* Resource served on the REST interface --> <type value="[code]"/><!-- 1..1 A resource type that is supported --> <profile><!-- 0..1 Reference(StructureDefinition) Base System profile for all uses of resource --></profile> <interaction> <!-- 1..* What operations are supported? --><<code value="[code]"/><!-- 1..1 read | vread | update | delete | history-instance | history-type | create | search-type --> <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update --> <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions --> <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity --> <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create --> <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update --> <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported --> <searchInclude value="[string]"/><!-- 0..* _include values supported by the server --> <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server --> <searchParam> <!-- 0..* Search params supported by implementation --> <name value="[string]"/><!-- 1..1 Name of search parameter --> <definition value="[uri]"/><!-- 0..1 Source of definition for parameter --> <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri --> <documentation value="[string]"/><!-- 0..1 Server-specific usage --> <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) --> <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type --> <chain value="[string]"/><!-- 0..* Chained names supported --> </searchParam> </resource> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 transaction | search-system | history-system --> <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <transactionMode value="[code]"/><!-- 0..1 not-supported | batch | transaction | both --> <searchParam><!-- 0..* Content as for Conformance.rest.resource.searchParam Search params for searching all resources --></searchParam> <operation> <!-- 0..* Definition of an operation or a custom query --><<name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked --> <definition><!-- 1..1 Reference(OperationDefinition) The defined operation/query --></definition> </operation><<compartment value="[uri]"/><!-- 0..* Compartments served/used by system --> </rest> <messaging> <!--0..* If messaging is supported -->
<<endpoint> <!-- 0..* Where messages should be sent --> <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol> <address value="[uri]"/><!-- 1..1 Address of end-point --> </endpoint> <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) --> <documentation value="[string]"/><!-- 0..1 Messaging interface behavior details --> <event> <!-- 1..* Declare support for this event --> <code><!-- 1..1 Coding Event type --></code> <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification --> <mode value="[code]"/><!-- 1..1 sender | receiver --> <focus value="[code]"/><!-- 1..1 Resource that's focus of message --> <request><!-- 1..1 Reference(StructureDefinition) Profile that describes the request --></request> <response><!-- 1..1 Reference(StructureDefinition) Profile that describes the response --></response> <documentation value="[string]"/><!-- 0..1 Endpoint-specific event documentation --> </event> </messaging> <document> <!--0..* Document definition --> <mode value="[code]"/><!-- 1..1 producer | consumer --> <documentation value="[string]"/><!-- 0..1 Description of document support --> <profile><!-- 1..1 Reference(StructureDefinition) Constraint on a resource used in the document --></profile> </document> </Conformance>
JSON
Template
JSON Template
{
"resourceType" : "Conformance",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical uri to reference this statement
"version" : "<string>", // Logical id for this version of the statement
"name" : "<string>", // Informal name for this conformance statement
"
"status" : "<code>", // R! draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"date" : "<dateTime>", // R! Publication Date(/time)
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"description" : "<string>", // C? Human description of the conformance statement
"
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<string>", // Why this resource has been created
"copyright" : "<string>", // Use and/or publishing restrictions
"kind" : "<code>", // R! instance | capability | requirements
"software" : { // C? Software that is covered by this conformance statement
"name" : "<string>", // R! A name the software is known by
"version" : "<string>", // Version covered by this statement
"releaseDate" : "<dateTime>" // Date this version released
},
"implementation" : { // C? If this describes a specific instance
"description" : "<string>", // R! Describes this specific instance
"url" : "<uri>" // Base URL for the installation
},
"fhirVersion" : "<id>", // R! FHIR Version the system uses
"acceptUnknown" : "<code>", // R! no | extensions | elements | both
"format" : ["<code>"], // R! formats supported (xml | json | mime type)
"profile" : [{ Reference(StructureDefinition) }], // Profiles for use cases supported
"rest" : [{ // C? If the endpoint is a RESTful one
"mode" : "<code>", // R! client | server
"documentation" : "<string>", // General description of implementation
"security" : { // Information about security of implementation
"cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/)
"service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
"description" : "<string>", // General description of how security works
"certificate" : [{ // Certificates associated with security profiles
"type" : "<code>", // Mime type for certificate
"blob" : "<base64Binary>" // Actual certificate
}]
},
"
"resource" : [{ // Resource served on the REST interface
"type" : "<code>", // R! A resource type that is supported
"profile" : { Reference(StructureDefinition) }, // Base System profile for all uses of resource
"interaction" : [{ // R! What operations are supported?
"
"code" : "<code>", // R! read | vread | update | delete | history-instance | history-type | create | search-type
"documentation" : "<string>" // Anything special about operation behavior
}],
"versioning" : "<code>", // no-version | versioned | versioned-update
"readHistory" : <boolean>, // Whether vRead can return past versions
"updateCreate" : <boolean>, // If update can commit to a new identity
"conditionalCreate" : <boolean>, // If allows/uses conditional create
"conditionalUpdate" : <boolean>, // If allows/uses conditional update
"conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
"searchInclude" : ["<string>"], // _include values supported by the server
"searchRevInclude" : ["<string>"], // _revinclude values supported by the server
"searchParam" : [{ // Search params supported by implementation
"name" : "<string>", // R! Name of search parameter
"definition" : "<uri>", // Source of definition for parameter
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri
"documentation" : "<string>", // Server-specific usage
"target" : ["<code>"], // Types of resource (if a resource reference)
"modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type
"chain" : ["<string>"] // Chained names supported
}]
}],
"interaction" : [{ // What operations are supported?
"code" : "<code>", // R! transaction | search-system | history-system
"documentation" : "<string>" // Anything special about operation behavior
}],
"transactionMode" : "<code>", // not-supported | batch | transaction | both
"searchParam" : [{ Content as for Conformance.rest.resource.searchParam }], // Search params for searching all resources
"operation" : [{ // Definition of an operation or a custom query
"
"name" : "<string>", // R! Name by which the operation/query is invoked
"definition" : { Reference(OperationDefinition) } // R! The defined operation/query
}],
"
"compartment" : ["<uri>"] // Compartments served/used by system
}],
"messaging" : [{ // C? If messaging is supported
"
"endpoint" : [{ // Where messages should be sent
"protocol" : { Coding }, // R! http | ftp | mllp +
"address" : "<uri>" // R! Address of end-point
}],
"reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
"documentation" : "<string>", // Messaging interface behavior details
"event" : [{ // R! Declare support for this event
"code" : { Coding }, // R! Event type
"category" : "<code>", // Consequence | Currency | Notification
"mode" : "<code>", // R! sender | receiver
"focus" : "<code>", // R! Resource that's focus of message
"request" : { Reference(StructureDefinition) }, // R! Profile that describes the request
"response" : { Reference(StructureDefinition) }, // R! Profile that describes the response
"documentation" : "<string>" // Endpoint-specific event documentation
}]
}],
"document" : [{ // C? Document definition
"mode" : "<code>", // R! producer | consumer
"documentation" : "<string>", // Description of document support
"profile" : { Reference(StructureDefinition) } // R! Constraint on a resource used in the document
}]
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | ConformanceResourceStatus |
| Conformance.useContext | Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. | Extensible | Context of Use ValueSet |
|
|
|
Required | ConformanceStatementKind |
|
|
|
Required | UnknownContentCode |
|
Conformance.format
|
|
Required |
|
|
|
|
Required | RestfulConformanceMode |
|
|
|
Extensible | RestfulSecurityService |
|
Conformance.rest.resource.type
Conformance.rest.resource.searchParam.target |
|
Required | http://hl7.org/fhir/valueset/resource-types ResourceType |
|
|
|
Required | TypeRestfulInteraction |
|
|
|
Required | ResourceVersionPolicy |
|
|
|
Required | ConditionalDeleteStatus |
|
|
|
Required | SearchParamType |
|
|
|
Required | SearchModifierCode |
|
|
|
Required | SystemRestfulInteraction |
|
|
|
Required | TransactionMode |
|
|
|
Extensible | MessageTransport |
|
|
|
Preferred | http://hl7.org/fhir/valueset/message-events MessageEvent |
|
|
|
Required | MessageSignificanceCategory |
|
|
|
Required | ConformanceEventMode |
|
|
|
Required | DocumentMode |
A conformance profile declares two different kinds of profiles for the functionality it describes. For a discussion of the use of these two types of resources, see two uses for profiles .
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| context | token | A use context assigned to the conformance statement | Conformance.useContext |
| date | date |
|
Conformance.date |
| description | string |
|
Conformance.description |
| event | token |
|
Conformance.messaging.event.code |
| fhirversion | token |
|
Conformance.version |
| format | token |
|
Conformance.format |
| mode | token |
|
Conformance.rest.mode |
| name | string |
|
Conformance.name |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( StructureDefinition ) |
|
|
token |
|
Conformance.rest.security.service |
| software | string |
|
Conformance.software.name |
| status | token |
|
Conformance.status |
| supported-profile | reference |
|
Conformance.profile
( StructureDefinition ) |
| url | uri |
|
Conformance.url |
| version | token |
|
Conformance.version |