The formal definitions for the elements in the conformance resource. Also available as an XML file.
Conformance |
Definition | A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation |
Control | 1..1 |
RIM Mapping | N/A |
To Do | Need to capture wire format (XML vs. JSON) and character set. Probably separately for each rest, messaging & document repetition. |
Conformance.date |
Definition | Date that the conformance statement is published |
Control | 1..1 |
Type | dateTime |
RIM Mapping | N/A |
Conformance.publisher |
Definition | The organization that publishes this conformance statement |
Control | 1..1 |
RIM Mapping | N/A |
Conformance.publisher.name |
Definition | Name of Organization |
Control | 1..1 |
Type | string |
RIM Mapping | N/A |
Conformance.publisher.address |
Definition | Address of Organization |
Control | 0..1 |
Type | Address |
RIM Mapping | N/A |
Conformance.publisher.contact |
Definition | Contacts for Organization relevant to this conformance statement. May be website, email, phone numbers, etc. |
Control | 0..* |
Type | Contact |
RIM Mapping | N/A |
Conformance.implementation |
Definition | Describes the implementation that is covered by this conformance statement. Used when the profile describes the capabilities of a specific implementation instance. |
Control | 0..1 |
RIM Mapping | N/A |
Conformance.implementation.description |
Definition | Information about the specific implementation |
Control | 1..1 |
Type | string |
RIM Mapping | N/A |
Conformance.implementation.url |
Definition | The base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. |
Control | 0..1 |
Type | uri |
RIM Mapping | N/A |
Conformance.software |
Definition | Describes the software that is covered by this conformance statement. Used when the profile describes the capabilities of a particular software version, independent of an installation. |
Control | 0..1 |
RIM Mapping | N/A |
Conformance.software.name |
Definition | Name software is known by |
Control | 1..1 |
Type | string |
RIM Mapping | N/A |
Conformance.software.version |
Definition | Version covered by this statement |
Control | 0..1 |
Type | string |
Comments | If possible, version should be specified, as statements are likely to be different for different versions of software |
RIM Mapping | N/A |
Conformance.software.releaseDate |
Definition | Date this version of the software released |
Control | 0..1 |
Type | dateTime |
RIM Mapping | N/A |
Conformance.proposal |
Definition | Describes the proposed solution described by this conformance statement. 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. |
Control | 0..1 |
RIM Mapping | N/A |
Conformance.proposal.description |
Definition | Provides details about the intention and scope of the proposal |
Control | 1..1 |
Type | string |
RIM Mapping | N/A |
Conformance.version |
Definition | The version of the FHIR specification on which this conformance profile is based |
Control | 1..1 |
Type | id |
RIM Mapping | N/A |
Conformance.acceptUnknown |
Definition | Whether the application accepts unknown non-"must understand" elements as part of a resource. This does not include extensions, but genuine new additions to a resource |
Control | 1..1 |
Type | boolean |
RIM Mapping | N/A |
Conformance.rest |
Definition | Defines the restful capabilities of the solution, if any |
Control | 0..* |
Comments | Multiple repetitions allow definition of both client and server behaviors or possibly behaviors under different configuration settings (for software or requirements statements) |
RIM Mapping | N/A |
Conformance.rest.mode |
Definition | Identifies whether this portion of the statement is describing ability to initiate or receive restful operations |
Control | 1..1 |
Type | code from RestfulConformanceMode |
RIM Mapping | N/A |
Conformance.rest.documentation |
Definition | Provides documentation about the system's restful capabilities that apply across all applications, such as security |
Control | 0..1 |
Type | string |
To Do | Do we need something more formal for security capabilities? |
Conformance.rest.resource |
Definition | Identifies the restful capabilities of the solution for a specific resource type |
Control | 1..* |
Comments | Max of one repetition per resource type |
RIM Mapping | N/A |
Conformance.rest.resource.type |
Definition | Identifies the resource exposed via the restful interface |
Control | 1..1 |
Type | code from ResourceType |
RIM Mapping | N/A |
Conformance.rest.resource.profile |
Definition | Identifies the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations, along with the search parameters supported |
Control | 0..1 |
Type | uri |
RIM Mapping | N/A |
Conformance.rest.resource.operation |
Definition | Identifies a restful operation supported by the solution |
Control | 1..* |
Comments | The 'search' operation is handled separately |
RIM Mapping | N/A |
Conformance.rest.resource.operation.code |
Definition | Identifies which operation is supported |
Control | 1..1 |
Type | code from RestfulOperation |
RIM Mapping | N/A |
Conformance.rest.resource.operation.documentation |
Definition | Provides 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' |
Control | 0..1 |
Type | string |
Requirements | REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. |
RIM Mapping | N/A |
Conformance.rest.resource.history |
Definition | A flag for whether the server is able to return past versions as part of the vRead operation |
Control | 0..1 |
Type | boolean |
Comments | It is useful to support the vRead operation for current operations, even if past versions aren't available |
RIM Mapping | N/A |
Conformance.messaging |
Definition | Describes the messaging capabilities of the solution |
Control | 0..* |
Comments | Multiple repetitions allow the documentation of multiple endpoints per solution |
RIM Mapping | N/A |
Conformance.messaging.endpoint |
Definition | The address to which messages and/or replies are to be sent. |
Control | 0..1 |
Type | uri |
Comments | Can be just an identifier for solutions that do not use network addresses for routing. |
RIM Mapping | N/A |
Conformance.messaging.documentation |
Definition | Provides 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. |
Control | 0..1 |
Type | string |
Conformance.messaging.event |
Definition | Describes the solution's support for an event at this end point. |
Control | 1..* |
Comments | The same event may be listed up to two times - once as sender and once as receiver. |
RIM Mapping | N/A |
To Do | Need to add follow-ups and need to do more to flesh out messaging dynamic model |
Conformance.messaging.event.code |
Definition | Identifies the supported messaging event |
Control | 1..1 |
Type | code from MessageEvent |
RIM Mapping | N/A |
To Do | May need profile id as well if profiles can define message events |
Conformance.messaging.event.mode |
Definition | The mode of this event declaration - whether application is sender or receiver |
Control | 1..1 |
Type | code from ConformanceEventMode |
RIM Mapping | N/A |
Conformance.messaging.event.protocol |
Definition | Identifies the messaging transport protocol(s) supported by this endpoint |
Control | 0..* |
Type | Coding from MessageTransport |
To Do | Loosen this to "extensible" once tooling supports that. |
Conformance.messaging.event.focus |
Definition | Identifies the resource associated with the event. This is the resource that defines the event. |
Control | 1..1 |
Type | code from ResourceType |
Comments | This must be provided if the event type supports multiple different resource types |
RIM Mapping | N/A |
Conformance.messaging.event.request |
Definition | Information about the request for this event |
Control | 0..1 |
Type | uri |
RIM Mapping | N/A |
Conformance.messaging.event.response |
Definition | Information about the response for this event |
Control | 0..1 |
Type | uri |
RIM Mapping | N/A |
Conformance.messaging.event.documentation |
Definition | Guidance on how this event is handled, such as internal system trigger points, business rules, etc. |
Control | 0..1 |
Type | string |
Conformance.document |
Definition | A document definition |
Control | 0..* |
RIM Mapping | N/A |
Conformance.document.mode |
Definition | The mode of this event declaration - whether application is sender or receiver |
Control | 1..1 |
Type | code from DocumentMode |
RIM Mapping | N/A |
Conformance.document.documentation |
Definition | Describes how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc. |
Control | 0..1 |
Type | string |
RIM Mapping | N/A |
Conformance.document.profile |
Definition | Constraint on a resource used in the document |
Control | 1..1 |
Type | uri |
Comments | The first resource is the document resource |
RIM Mapping | N/A |
Conformance.extension |
Definition | See Extensions |
Control | 0..* |
Type | Extension |
RIM Mapping | N/A |
Conformance.text |
Definition | Text summary of resource (for human interpretation) |
Control | 1..1 |
Type | Narrative |
RIM Mapping | N/A |