This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Conformance - Formal Definitions 2.9.8

The formal definitions for the elements in the conformance resource. Also available as an XML file.

Conformance
DefinitionA conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation
Control1..1
RIM MappingN/A
To DoNeed to capture wire format (XML vs. JSON) and character set. Probably separately for each rest, messaging & document repetition.
Conformance.date
DefinitionDate that the conformance statement is published
Control1..1
TypedateTime
RIM MappingN/A
Conformance.publisher
DefinitionThe organization that publishes this conformance statement
Control1..1
RIM MappingN/A
Conformance.publisher.name
DefinitionName of Organization
Control1..1
Typestring
RIM MappingN/A
Conformance.publisher.address
DefinitionAddress of Organization
Control0..1
TypeAddress
RIM MappingN/A
Conformance.publisher.contact
DefinitionContacts for Organization relevant to this conformance statement. May be website, email, phone numbers, etc.
Control0..*
TypeContact
RIM MappingN/A
Conformance.implementation
DefinitionDescribes the implementation that is covered by this conformance statement. Used when the profile describes the capabilities of a specific implementation instance.
Control0..1
RIM MappingN/A
Conformance.implementation.description
DefinitionInformation about the specific implementation
Control1..1
Typestring
RIM MappingN/A
Conformance.implementation.url
DefinitionThe base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
Control0..1
Typeuri
RIM MappingN/A
Conformance.software
DefinitionDescribes 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.
Control0..1
RIM MappingN/A
Conformance.software.name
DefinitionName software is known by
Control1..1
Typestring
RIM MappingN/A
Conformance.software.version
DefinitionVersion covered by this statement
Control0..1
Typestring
CommentsIf possible, version should be specified, as statements are likely to be different for different versions of software
RIM MappingN/A
Conformance.software.releaseDate
DefinitionDate this version of the software released
Control0..1
TypedateTime
RIM MappingN/A
Conformance.proposal
DefinitionDescribes 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.
Control0..1
RIM MappingN/A
Conformance.proposal.description
DefinitionProvides details about the intention and scope of the proposal
Control1..1
Typestring
RIM MappingN/A
Conformance.version
DefinitionThe version of the FHIR specification on which this conformance profile is based
Control1..1
Typeid
RIM MappingN/A
Conformance.acceptUnknown
DefinitionWhether 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
Control1..1
Typeboolean
RIM MappingN/A
Conformance.rest
DefinitionDefines the restful capabilities of the solution, if any
Control0..*
CommentsMultiple repetitions allow definition of both client and server behaviors or possibly behaviors under different configuration settings (for software or requirements statements)
RIM MappingN/A
Conformance.rest.mode
DefinitionIdentifies whether this portion of the statement is describing ability to initiate or receive restful operations
Control1..1
Typecode from RestfulConformanceMode
RIM MappingN/A
Conformance.rest.documentation
DefinitionProvides documentation about the system's restful capabilities that apply across all applications, such as security
Control0..1
Typestring
To DoDo we need something more formal for security capabilities?
Conformance.rest.resource
DefinitionIdentifies the restful capabilities of the solution for a specific resource type
Control1..*
CommentsMax of one repetition per resource type
RIM MappingN/A
Conformance.rest.resource.type
DefinitionIdentifies the resource exposed via the restful interface
Control1..1
Typecode from ResourceType
RIM MappingN/A
Conformance.rest.resource.profile
DefinitionIdentifies 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
Control0..1
Typeuri
RIM MappingN/A
Conformance.rest.resource.operation
DefinitionIdentifies a restful operation supported by the solution
Control1..*
CommentsThe 'search' operation is handled separately
RIM MappingN/A
Conformance.rest.resource.operation.code
DefinitionIdentifies which operation is supported
Control1..1
Typecode from RestfulOperation
RIM MappingN/A
Conformance.rest.resource.operation.documentation
DefinitionProvides 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'
Control0..1
Typestring
RequirementsREST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.
RIM MappingN/A
Conformance.rest.resource.history
DefinitionA flag for whether the server is able to return past versions as part of the vRead operation
Control0..1
Typeboolean
CommentsIt is useful to support the vRead operation for current operations, even if past versions aren't available
RIM MappingN/A
Conformance.messaging
DefinitionDescribes the messaging capabilities of the solution
Control0..*
CommentsMultiple repetitions allow the documentation of multiple endpoints per solution
RIM MappingN/A
Conformance.messaging.endpoint
DefinitionThe address to which messages and/or replies are to be sent.
Control0..1
Typeuri
CommentsCan be just an identifier for solutions that do not use network addresses for routing.
RIM MappingN/A
Conformance.messaging.documentation
DefinitionProvides 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.
Control0..1
Typestring
Conformance.messaging.event
DefinitionDescribes the solution's support for an event at this end point.
Control1..*
CommentsThe same event may be listed up to two times - once as sender and once as receiver.
RIM MappingN/A
To DoNeed to add follow-ups and need to do more to flesh out messaging dynamic model
Conformance.messaging.event.code
DefinitionIdentifies the supported messaging event
Control1..1
Typecode from MessageEvent
RIM MappingN/A
To DoMay need profile id as well if profiles can define message events
Conformance.messaging.event.mode
DefinitionThe mode of this event declaration - whether application is sender or receiver
Control1..1
Typecode from ConformanceEventMode
RIM MappingN/A
Conformance.messaging.event.protocol
DefinitionIdentifies the messaging transport protocol(s) supported by this endpoint
Control0..*
TypeCoding from MessageTransport
To DoLoosen this to "extensible" once tooling supports that.
Conformance.messaging.event.focus
DefinitionIdentifies the resource associated with the event. This is the resource that defines the event.
Control1..1
Typecode from ResourceType
CommentsThis must be provided if the event type supports multiple different resource types
RIM MappingN/A
Conformance.messaging.event.request
DefinitionInformation about the request for this event
Control0..1
Typeuri
RIM MappingN/A
Conformance.messaging.event.response
DefinitionInformation about the response for this event
Control0..1
Typeuri
RIM MappingN/A
Conformance.messaging.event.documentation
DefinitionGuidance on how this event is handled, such as internal system trigger points, business rules, etc.
Control0..1
Typestring
Conformance.document
DefinitionA document definition
Control0..*
RIM MappingN/A
Conformance.document.mode
DefinitionThe mode of this event declaration - whether application is sender or receiver
Control1..1
Typecode from DocumentMode
RIM MappingN/A
Conformance.document.documentation
DefinitionDescribes how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.
Control0..1
Typestring
RIM MappingN/A
Conformance.document.profile
DefinitionConstraint on a resource used in the document
Control1..1
Typeuri
CommentsThe first resource is the document resource
RIM MappingN/A
Conformance.extension
DefinitionSee Extensions
Control0..*
TypeExtension
RIM MappingN/A
Conformance.text
DefinitionText summary of resource (for human interpretation)
Control1..1
TypeNarrative
RIM MappingN/A

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.06 generated on Tue, Dec 4, 2012 00:04+1100. License