This page is part of the FHIR Specification (v0.01: Historical Archive Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Conformance

A conformance statement returned by request in an RESTful framework.

The relative url is /conformances

Content

UML Image

<Conformance xmlns="http://www.hl7.org/fhir">
  <id> mand id ConformanceStatement Id (UUID)</id>
  <date> mand dateTime Publication Date</date>
  <publisher> mand 
   <name> mand string Publishing Organization</name>
   <address> opt Zero+ Address Address of Organization</address>
   <contact> opt Zero+ Contact Contacts for Organization</contact>
  </publisher>
  <software> mand 
   <name> mand string Name software is known by</name>
   <version> mand string Version covered by this statement</version>
   <releaseDate> opt dateTime Date this version released</releaseDate>
  </software>
  <mode> mand code client | server</mode>
  <profile> opt Zero+ uri other profiles that apply (i.e. code binding rules)</profile>
  <resource> mand Constraint Resource Type with constraints</resource>
  <operation> cond 
   <read> opt boolean if supported</read>
   <vread> opt boolean if supported</vread>
   <update> opt boolean if supported</update>
   <delete> opt boolean if supported</delete>
   <validate> opt boolean if supported</validate>
   <history> opt boolean if supported</history>
   <transaction> opt  <!-- only if supported -->
    <name> mand One+ code transaction names supported</name>
   </transaction>
   <search> opt  <!-- only if supported -->
    <param> mand One+ string search params supported</param>
   </search>
   <create> opt  <!-- if supported -->
    <id> mand code source of id: client | server | either</id>
   </create>
   <updates> opt boolean  <!-- if supported -->
    <param> mand Zero+ string update filter params supported</param>
   </updates>
   <schema> opt boolean if supported</schema>
  </operation>
  <extensions> opt See Extensions   See Extensions </extensions>
  <text> mand Narrative Text summary of conformance profile for human interpretation</text>
</Conformance>

Schema for Conformance and an example (or formatted for browser)

Terminology Bindings

Conformance.mode is bound to the concept domain RestfulConformanceMode: "The mode of a restful conformance statement". Possible values:

client The application acts as a server for this resource

server The application acts as a client for this resource
Conformance.resource is bound to the concept domain ResourceType which has the allowed values of any defined Resource Type name

Conformance.operation.create.id is bound to the concept domain ResourceIdSource: "The system responsible for the provision of a resource unique id". Possible values:

client	The client must provide a unique resource id
server	The server defines the id and will reject any client attempt to define it
either	The client can provide a unique resource id, or the server will define it instead

Notes:

The MessageConformance resource is a special case; it is only defined for the conformance framework, and is not encountered in other contexts
The interpretation of request and resource depends on the mode. If the mode is sender, then request specifies what the application sends, and response specifies what it accepts. If the mode is "listener", then this is reversed
If a request or response is not specified for an event, then no rules are made for it
Events that are not listed are not supported

Formal Definitions

The formal definitions for the elements above. Also available as an XML file.

Conformance
Definition	A conformance statement returned by request in an RESTful framework
Control	Mandatory, 1..1
Conformance.id
Definition	Globally unique Conformance Statement Id (Must be a UUID)
Control	Mandatory, 1..1
Type	id
Conformance.date
Definition	Date that the conformance statement is published
Control	Mandatory, 1..1
Type	dateTime
Conformance.publisher
Definition	The organization that publishes this conformance statement
Control	Mandatory, 1..1
Conformance.publisher.name
Definition	Name of Organization
Control	Mandatory, 1..1
Type	string
Conformance.publisher.address
Definition	Address of Organization
Control	Optional, 0..*
Type	Address
Conformance.publisher.contact
Definition	Contacts for Organization
Control	Optional, 0..*
Type	Contact
Conformance.software
Definition	The software that is covered by this conformance statement
Control	Mandatory, 1..1
Conformance.software.name
Definition	Name software is known by
Control	Mandatory, 1..1
Type	string
Conformance.software.version
Definition	Version covered by this statement
Control	Mandatory, 1..1
Type	string
Conformance.software.releaseDate
Definition	Date this version released
Control	Optional, 0..1
Type	dateTime
Conformance.mode
Definition	client \| server
Control	Mandatory, 1..1
Type	code from RestfulConformanceMode
Conformance.profile
Definition	Additional other profiles that apply to this conformance statement.
Control	Optional, 0..*
Type	uri
Comments	Generally these profiles make constraints on the bindings of concept domains / value sets
Conformance.resource
Definition	Resource Type with constraints
Control	Mandatory, 1..1
Type	Constraint from ResourceType
Conformance.operation
Control	Conditional, 0..1: A resource type is required if the event declaration has multiple focal resources
Conformance.operation.read
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.vread
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.update
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.delete
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.validate
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.history
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.transaction
Definition	only if supported
Control	Optional, 0..1
Conformance.operation.transaction.name
Definition	transaction names supported
Control	Mandatory, 1..*
Type	code
Conformance.operation.search
Definition	only if supported
Control	Optional, 0..1
Conformance.operation.search.param
Definition	search params supported
Control	Mandatory, 1..*
Type	string
Conformance.operation.create
Definition	if supported
Control	Optional, 0..1
Conformance.operation.create.id
Definition	source of id: client \| server \| either
Control	Mandatory, 1..1
Type	code from ResourceIdSource
Conformance.operation.updates
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.operation.updates.param
Definition	update filter params supported
Control	Mandatory, 0..*
Type	string
Conformance.operation.schema
Definition	if supported
Control	Optional, 0..1
Type	boolean
Conformance.extensions
Definition	See Extensions
Control	Optional, 0..1
Conformance.text
Definition	Text summary of conformance profile for human interpretation
Control	Mandatory, 1..1
Type	Narrative

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.01 generated on Mon, May 14, 2012 09:48+1000.

client	The application acts as a server for this resource
server	The application acts as a client for this resource