PATIENT ADMINISTRTAION (PA) Workgroup Development Draft

6.16 Resource Conformance - Content

This resource maintained by the FHIR Management Group Work Group

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.

6.16.1 Scope and Usage

Conformance statements are used in one of three ways:

6.16.1.1 Describe 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.

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.

A conformance statement is identified as being an implementation statement through the presence of the implementation element.

6.16.1.2 Describe 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.

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.

A conformance statement is identified as being a software solution statement through the presence of the software element.

6.16.1.3 Describe 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.

A conformance statement is identified as being a requirements statement through the presence of the proposal element.

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.

6.16.2 Background and Context

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.

6.16.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Conformance IDomainResourceA conformance statement
There can only be one REST declaration per mode
The set of documents must be unique by the combination of profile & mode
If there is more than one messaging element, endpoint must be specified for each one
The set of end points listed for messaging must be unique
A Conformance statement SHALL have at least one of description, software, or implementation
A Conformance statement SHALL have at least one of rest, messaging or document
... url Σ0..1uriLogical uri to reference this statement
... version Σ0..1stringLogical id for this version of the statement
... name Σ0..1stringInformal name for this conformance statement
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ElementContact details of the publisher
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... description Σ I0..1stringHuman description of the conformance statement
... requirements 0..1stringWhy is this needed?
... copyright 0..1stringUse and/or Publishing restrictions
... status ?! Σ0..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ1..1dateTimePublication Date(/time)
... software Σ I0..1ElementSoftware that is covered by this conformance statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation Σ I0..1ElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version
... acceptUnknown Σ1..1booleanTrue if application accepts unknown elements
... format 1..*codeformats supported (xml | json | mime type)
MimeType (Required)
... profile 0..*StructureDefinitionProfiles supported by the system
... rest I0..*ElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
A given query can only be described once per RESTful mode
.... mode 1..1codeclient | server
RestfulConformanceMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security 0..1ElementInformation about security of implementation
..... cors 0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service 0..*CodeableConceptOAuth | OAuth2 | NTLM | Basic | Kerberos
RestfulSecurityService (Required)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*ElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource I1..*ElementResource served on the REST interface
Operation codes must be unique in the context of a resource
Search parameter names must be unique in the context of a resource
..... type 1..1codeA resource type that is supported
ResourceType (Required)
..... profile 0..1StructureDefinitionWhat structural features are supported
..... interaction 1..*ElementWhat operations are supported?
...... code 1..1coderead | vread | update | delete | history-instance | validate | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1booleanIf allows/uses conditional delete
..... searchInclude 0..*string_include values supported by the server
..... searchParam 0..*ElementSearch params supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
...... target 0..*codeTypes of resource (if a resource reference)
ResourceType (Required)
...... chain 0..*stringChained names supported
.... interaction 0..*ElementWhat operations are supported?
..... code 1..1codetransaction | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... operation 0..*ElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition 1..1OperationDefinitionThe defined operation/query
.... documentMailbox 0..*uriHow documents are accepted in /Mailbox
.... compartment 0..*uriCompartments served/used by system
... messaging I0..*ElementIf messaging is supported
The set of events per messaging endpoint must be unique by the combination of code & mode
Messaging end point is required (and is only permitted) when statement is for an implementation
.... endpoint I0..1uriActual endpoint being described
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event 1..*ElementDeclare support for this event
..... code 1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
ConformanceEventMode (Required)
..... protocol 0..*Codinghttp | ftp | mllp +
MessageTransport (Required)
..... focus 1..1codeResource that's focus of message
ResourceType (Required)
..... request 1..1StructureDefinitionProfile that describes the request
..... response 1..1StructureDefinitionProfile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document I0..*ElementDocument definition
.... mode 1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1stringDescription of document support
.... profile 1..1StructureDefinitionConstraint on a resource used in the document

UML Diagram

Conformance (DomainResource)An absolute uri that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:)url : uri 0..1The 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 timestampversion : string 0..1A free text natural language name identifying the conformance statementname : string 0..1The name of the individual or organization that published the conformancepublisher : string 0..1A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : string 0..1Explains why this conformance statement is needed and why it's been constrained as it hasrequirements : string 0..1A copyright statement relating to the conformamce statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statementcopyright : string 0..1The status of this conformance statement (this element modifies the meaning of other elements)status : code 0..1 « The lifecycle status of a Value Set or Concept MapConformanceResourceStatus »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 usageexperimental : boolean 0..1The date (and optionally time) when the conformance statement was publisheddate : dateTime 1..1The version of the FHIR specification on which this conformance statement is basedfhirVersion : id 1..1A flag that indicates whether the application accepts unknown elements as part of a resourceacceptUnknown : boolean 1..1A list of the formats supported by this implementation using their content typesformat : code 1..* « The mime type of an attachmentMimeType »A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources, 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 profileprofile : Reference(StructureDefinition) 0..*ContactThe name of an individual to contact regarding the conformancename : string 0..1Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint 0..*SoftwareName software is known byname : string 1..1The version identifier for the software covered by this statementversion : string 0..1Date this version of the software releasedreleaseDate : dateTime 0..1ImplementationInformation about the specific installation that this conformance statement relates todescription : string 1..1An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfacesurl : uri 0..1RestIdentifies whether this portion of the statement is describing ability to initiate or receive restful operationsmode : code 1..1 « The mode of a RESTful conformance statementRestfulConformanceMode »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : string 0..1A list of absolute URIs that identify 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 purposedocumentMailbox : uri 0..*An absolute URI which is a reference to the definition of a compartment hosted by the systemcompartment : uri 0..*SecurityServer adds CORS headers when responding to requests - this enables javascript applications to use the servercors : boolean 0..1Types of security services are supported/required by the systemservice : CodeableConcept 0..* « Types of security services used with FHIRRestfulSecurityService »General description of how security worksdescription : string 0..1CertificateMime type for certificatetype : code 0..1 « The mime type of an attachmentMimeType »Actual certificateblob : base64Binary 0..1ResourceA type of resource exposed via the restful interfacetype : code 1..1 « One of the resource types defined as part of FHIRResourceType »A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitationsprofile : Reference(StructureDefinition) 0..1Thi field is set to true to specify that the system does not support (server) or use (client) versioning for this resource type. If this is not set to true, the server must at least correctly track and populate the versionId meta-property on resourcesversioning : code 0..1 « How the system supports versioning for a resourceResourceVersionPolicy »A flag for whether the server is able to return past versions as part of the vRead operationreadHistory : boolean 0..1A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the serverupdateCreate : boolean 0..1A flag that indicates that the server supports conditional createconditionalCreate : boolean 0..1A flag that indicates that the server supports conditional updateconditionalUpdate : boolean 0..1A flag that indicates that the server supports conditional deleteconditionalDelete : boolean 0..1A list of _include values supported by the serversearchInclude : string 0..*ResourceInteractionCoded identifier of the operation, supported by the system resourcecode : code 1..1 « Operations supported by REST at the type or instance levelTypeRestfulInteraction »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'documentation : string 0..1SearchParamThe name of the search parameter used in the interfacename : string 1..1An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])definition : uri 0..1The type of value a search parameter refers to, and how the content is interpretedtype : code 1..1 « Data types allowed to be used for search parametersSearchParamType »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : string 0..1Types of resource (if a resource is referenced)target : code 0..* « One of the resource types defined as part of FHIRResourceType »Chained names supportedchain : string 0..*SystemInteractionA coded identifier of the operation, supported by the systemcode : code 1..1 « Operations supported by REST at the system levelSystemRestfulInteraction »Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implementeddocumentation : string 0..1OperationThe name of a query, which is used in the _query parameter when the query is calledname : string 1..1Where the formal definition can be founddefinition : Reference(OperationDefinition) 1..1MessagingAn address to which messages and/or replies are to be sentendpoint : uri 0..1Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender)reliableCache : unsignedInt 0..1Documentation 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 partnerdocumentation : string 0..1EventA coded identifier of a supported messaging eventcode : Coding 1..1 « One of the message events defined as part of FHIRMessageEvent+ »The impact of the content of the messagecategory : code 0..1 « The impact of the content of a messageMessageSignificanceCategory »The mode of this event declaration - whether application is sender or receivermode : code 1..1 « The mode of a message conformance statementConformanceEventMode »A list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding 0..* « The protocol used for message transportMessageTransport »A resource associated with the event. This is the resource that defines the eventfocus : code 1..1 « One of the resource types defined as part of FHIRResourceType »Information about the request for this eventrequest : Reference(StructureDefinition) 1..1Information about the response for this eventresponse : Reference(StructureDefinition) 1..1Guidance on how this event is handled, such as internal system trigger points, business rules, etcdocumentation : string 0..1DocumentMode of this document declaration - whether application is producer or consumermode : code 1..1 « Whether the application produces or consumes documentsDocumentMode »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, etcdocumentation : string 0..1A constraint on a resource used in the documentprofile : Reference(StructureDefinition) 1..1Contacts to assist a user in finding and communicating with the publishercontact0..*Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installationsoftware0..1Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software programimplementation0..1Certificates associated with security profilescertificate0..*Information about security implementation from an interface perspective - what a client needs to knowsecurity0..1Identifies a restful operation supported by the solutioninteraction1..*Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam0..*A specification of the restful capabilities of the solution for a specific resource typeresource1..*A specification of restful operations supported by the systeminteraction0..*Definition of an operation or a named query and with its parameters and their meaning and typeoperation0..*A definition of the restful capabilities of the solution, if anyrest0..*A description of the solution's support for an event at this end pointevent1..*A description of the messaging capabilities of the solutionmessaging0..*A document definitiondocument0..*

XML Template

<Conformance xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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 a 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 -->
 <requirements value="[string]"/><!-- 0..1 Why is this needed? -->
 <copyright value="[string]"/><!-- 0..1 Use and/or Publishing restrictions -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) -->
 <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 -->
 <acceptUnknown value="[boolean]"/><!-- 1..1 True if application accepts unknown elements -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | mime type) -->
 <profile><!-- 0..* Reference(StructureDefinition) Profiles supported by the system --></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 | OAuth2 | NTLM | Basic | Kerberos --></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>  <!-- 1..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 Reference(StructureDefinition) What structural features are supported --></profile>
   <interaction>  <!-- 1..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | delete | history-instance | validate | 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="[boolean]"/><!-- 0..1 If allows/uses conditional delete -->
   <searchInclude value="[string]"/><!-- 0..* _include 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) -->
    <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>
  <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>
  <documentMailbox value="[uri]"/><!-- 0..* How documents are accepted in /Mailbox -->
  <compartment value="[uri]"/><!-- 0..* Compartments served/used by system -->
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint value="[uri]"/><!-- ?? 0..1 Actual endpoint being described -->
  <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 -->
   <protocol><!-- 0..* Coding http | ftp | mllp + --></protocol>
   <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

{doco
  "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
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "description" : "<string>", // C? Human description of the conformance statement
  "requirements" : "<string>", // Why is this needed?
  "copyright" : "<string>", // Use and/or Publishing restrictions
  "status" : "<code>", // draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // R!  Publication Date(/time)
  "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
  "acceptUnknown" : <boolean>, // R!  True if application accepts unknown elements
  "format" : ["<code>"], // R!  formats supported (xml | json | mime type)
  "profile" : [{ Reference(StructureDefinition) }], // Profiles supported by the system
  "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 | OAuth2 | NTLM | Basic | Kerberos
      "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" : [{ // R!  Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { Reference(StructureDefinition) }, // What structural features are supported
      "interaction" : [{ // R!  What operations are supported?
        "code" : "<code>", // R!  read | vread | update | delete | history-instance | validate | 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" : <boolean>, // If allows/uses conditional delete
      "searchInclude" : ["<string>"], // _include 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)
        "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
    }],
    "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
    }],
    "documentMailbox" : ["<uri>"], // How documents are accepted in /Mailbox
    "compartment" : ["<uri>"] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : "<uri>", // C? Actual endpoint being described
    "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
      "protocol" : [{ Coding }], // http | ftp | mllp +
      "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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Conformance IDomainResourceA conformance statement
There can only be one REST declaration per mode
The set of documents must be unique by the combination of profile & mode
If there is more than one messaging element, endpoint must be specified for each one
The set of end points listed for messaging must be unique
A Conformance statement SHALL have at least one of description, software, or implementation
A Conformance statement SHALL have at least one of rest, messaging or document
... url Σ0..1uriLogical uri to reference this statement
... version Σ0..1stringLogical id for this version of the statement
... name Σ0..1stringInformal name for this conformance statement
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ElementContact details of the publisher
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... description Σ I0..1stringHuman description of the conformance statement
... requirements 0..1stringWhy is this needed?
... copyright 0..1stringUse and/or Publishing restrictions
... status ?! Σ0..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ1..1dateTimePublication Date(/time)
... software Σ I0..1ElementSoftware that is covered by this conformance statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation Σ I0..1ElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version
... acceptUnknown Σ1..1booleanTrue if application accepts unknown elements
... format 1..*codeformats supported (xml | json | mime type)
MimeType (Required)
... profile 0..*StructureDefinitionProfiles supported by the system
... rest I0..*ElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
A given query can only be described once per RESTful mode
.... mode 1..1codeclient | server
RestfulConformanceMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security 0..1ElementInformation about security of implementation
..... cors 0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service 0..*CodeableConceptOAuth | OAuth2 | NTLM | Basic | Kerberos
RestfulSecurityService (Required)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*ElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource I1..*ElementResource served on the REST interface
Operation codes must be unique in the context of a resource
Search parameter names must be unique in the context of a resource
..... type 1..1codeA resource type that is supported
ResourceType (Required)
..... profile 0..1StructureDefinitionWhat structural features are supported
..... interaction 1..*ElementWhat operations are supported?
...... code 1..1coderead | vread | update | delete | history-instance | validate | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1booleanIf allows/uses conditional delete
..... searchInclude 0..*string_include values supported by the server
..... searchParam 0..*ElementSearch params supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
...... target 0..*codeTypes of resource (if a resource reference)
ResourceType (Required)
...... chain 0..*stringChained names supported
.... interaction 0..*ElementWhat operations are supported?
..... code 1..1codetransaction | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... operation 0..*ElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition 1..1OperationDefinitionThe defined operation/query
.... documentMailbox 0..*uriHow documents are accepted in /Mailbox
.... compartment 0..*uriCompartments served/used by system
... messaging I0..*ElementIf messaging is supported
The set of events per messaging endpoint must be unique by the combination of code & mode
Messaging end point is required (and is only permitted) when statement is for an implementation
.... endpoint I0..1uriActual endpoint being described
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event 1..*ElementDeclare support for this event
..... code 1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
ConformanceEventMode (Required)
..... protocol 0..*Codinghttp | ftp | mllp +
MessageTransport (Required)
..... focus 1..1codeResource that's focus of message
ResourceType (Required)
..... request 1..1StructureDefinitionProfile that describes the request
..... response 1..1StructureDefinitionProfile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document I0..*ElementDocument definition
.... mode 1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1stringDescription of document support
.... profile 1..1StructureDefinitionConstraint on a resource used in the document

UML Diagram

Conformance (DomainResource)An absolute uri that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:)url : uri 0..1The 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 timestampversion : string 0..1A free text natural language name identifying the conformance statementname : string 0..1The name of the individual or organization that published the conformancepublisher : string 0..1A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : string 0..1Explains why this conformance statement is needed and why it's been constrained as it hasrequirements : string 0..1A copyright statement relating to the conformamce statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statementcopyright : string 0..1The status of this conformance statement (this element modifies the meaning of other elements)status : code 0..1 « The lifecycle status of a Value Set or Concept MapConformanceResourceStatus »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 usageexperimental : boolean 0..1The date (and optionally time) when the conformance statement was publisheddate : dateTime 1..1The version of the FHIR specification on which this conformance statement is basedfhirVersion : id 1..1A flag that indicates whether the application accepts unknown elements as part of a resourceacceptUnknown : boolean 1..1A list of the formats supported by this implementation using their content typesformat : code 1..* « The mime type of an attachmentMimeType »A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources, 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 profileprofile : Reference(StructureDefinition) 0..*ContactThe name of an individual to contact regarding the conformancename : string 0..1Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint 0..*SoftwareName software is known byname : string 1..1The version identifier for the software covered by this statementversion : string 0..1Date this version of the software releasedreleaseDate : dateTime 0..1ImplementationInformation about the specific installation that this conformance statement relates todescription : string 1..1An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfacesurl : uri 0..1RestIdentifies whether this portion of the statement is describing ability to initiate or receive restful operationsmode : code 1..1 « The mode of a RESTful conformance statementRestfulConformanceMode »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : string 0..1A list of absolute URIs that identify 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 purposedocumentMailbox : uri 0..*An absolute URI which is a reference to the definition of a compartment hosted by the systemcompartment : uri 0..*SecurityServer adds CORS headers when responding to requests - this enables javascript applications to use the servercors : boolean 0..1Types of security services are supported/required by the systemservice : CodeableConcept 0..* « Types of security services used with FHIRRestfulSecurityService »General description of how security worksdescription : string 0..1CertificateMime type for certificatetype : code 0..1 « The mime type of an attachmentMimeType »Actual certificateblob : base64Binary 0..1ResourceA type of resource exposed via the restful interfacetype : code 1..1 « One of the resource types defined as part of FHIRResourceType »A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitationsprofile : Reference(StructureDefinition) 0..1Thi field is set to true to specify that the system does not support (server) or use (client) versioning for this resource type. If this is not set to true, the server must at least correctly track and populate the versionId meta-property on resourcesversioning : code 0..1 « How the system supports versioning for a resourceResourceVersionPolicy »A flag for whether the server is able to return past versions as part of the vRead operationreadHistory : boolean 0..1A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the serverupdateCreate : boolean 0..1A flag that indicates that the server supports conditional createconditionalCreate : boolean 0..1A flag that indicates that the server supports conditional updateconditionalUpdate : boolean 0..1A flag that indicates that the server supports conditional deleteconditionalDelete : boolean 0..1A list of _include values supported by the serversearchInclude : string 0..*ResourceInteractionCoded identifier of the operation, supported by the system resourcecode : code 1..1 « Operations supported by REST at the type or instance levelTypeRestfulInteraction »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'documentation : string 0..1SearchParamThe name of the search parameter used in the interfacename : string 1..1An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])definition : uri 0..1The type of value a search parameter refers to, and how the content is interpretedtype : code 1..1 « Data types allowed to be used for search parametersSearchParamType »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : string 0..1Types of resource (if a resource is referenced)target : code 0..* « One of the resource types defined as part of FHIRResourceType »Chained names supportedchain : string 0..*SystemInteractionA coded identifier of the operation, supported by the systemcode : code 1..1 « Operations supported by REST at the system levelSystemRestfulInteraction »Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implementeddocumentation : string 0..1OperationThe name of a query, which is used in the _query parameter when the query is calledname : string 1..1Where the formal definition can be founddefinition : Reference(OperationDefinition) 1..1MessagingAn address to which messages and/or replies are to be sentendpoint : uri 0..1Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender)reliableCache : unsignedInt 0..1Documentation 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 partnerdocumentation : string 0..1EventA coded identifier of a supported messaging eventcode : Coding 1..1 « One of the message events defined as part of FHIRMessageEvent+ »The impact of the content of the messagecategory : code 0..1 « The impact of the content of a messageMessageSignificanceCategory »The mode of this event declaration - whether application is sender or receivermode : code 1..1 « The mode of a message conformance statementConformanceEventMode »A list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding 0..* « The protocol used for message transportMessageTransport »A resource associated with the event. This is the resource that defines the eventfocus : code 1..1 « One of the resource types defined as part of FHIRResourceType »Information about the request for this eventrequest : Reference(StructureDefinition) 1..1Information about the response for this eventresponse : Reference(StructureDefinition) 1..1Guidance on how this event is handled, such as internal system trigger points, business rules, etcdocumentation : string 0..1DocumentMode of this document declaration - whether application is producer or consumermode : code 1..1 « Whether the application produces or consumes documentsDocumentMode »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, etcdocumentation : string 0..1A constraint on a resource used in the documentprofile : Reference(StructureDefinition) 1..1Contacts to assist a user in finding and communicating with the publishercontact0..*Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installationsoftware0..1Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software programimplementation0..1Certificates associated with security profilescertificate0..*Information about security implementation from an interface perspective - what a client needs to knowsecurity0..1Identifies a restful operation supported by the solutioninteraction1..*Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam0..*A specification of the restful capabilities of the solution for a specific resource typeresource1..*A specification of restful operations supported by the systeminteraction0..*Definition of an operation or a named query and with its parameters and their meaning and typeoperation0..*A definition of the restful capabilities of the solution, if anyrest0..*A description of the solution's support for an event at this end pointevent1..*A description of the messaging capabilities of the solutionmessaging0..*A document definitiondocument0..*

XML Template

<Conformance xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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 a 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 -->
 <requirements value="[string]"/><!-- 0..1 Why is this needed? -->
 <copyright value="[string]"/><!-- 0..1 Use and/or Publishing restrictions -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) -->
 <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 -->
 <acceptUnknown value="[boolean]"/><!-- 1..1 True if application accepts unknown elements -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | mime type) -->
 <profile><!-- 0..* Reference(StructureDefinition) Profiles supported by the system --></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 | OAuth2 | NTLM | Basic | Kerberos --></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>  <!-- 1..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 Reference(StructureDefinition) What structural features are supported --></profile>
   <interaction>  <!-- 1..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | delete | history-instance | validate | 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="[boolean]"/><!-- 0..1 If allows/uses conditional delete -->
   <searchInclude value="[string]"/><!-- 0..* _include 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) -->
    <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>
  <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>
  <documentMailbox value="[uri]"/><!-- 0..* How documents are accepted in /Mailbox -->
  <compartment value="[uri]"/><!-- 0..* Compartments served/used by system -->
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint value="[uri]"/><!-- ?? 0..1 Actual endpoint being described -->
  <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 -->
   <protocol><!-- 0..* Coding http | ftp | mllp + --></protocol>
   <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

{doco
  "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
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "description" : "<string>", // C? Human description of the conformance statement
  "requirements" : "<string>", // Why is this needed?
  "copyright" : "<string>", // Use and/or Publishing restrictions
  "status" : "<code>", // draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // R!  Publication Date(/time)
  "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
  "acceptUnknown" : <boolean>, // R!  True if application accepts unknown elements
  "format" : ["<code>"], // R!  formats supported (xml | json | mime type)
  "profile" : [{ Reference(StructureDefinition) }], // Profiles supported by the system
  "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 | OAuth2 | NTLM | Basic | Kerberos
      "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" : [{ // R!  Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { Reference(StructureDefinition) }, // What structural features are supported
      "interaction" : [{ // R!  What operations are supported?
        "code" : "<code>", // R!  read | vread | update | delete | history-instance | validate | 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" : <boolean>, // If allows/uses conditional delete
      "searchInclude" : ["<string>"], // _include 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)
        "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
    }],
    "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
    }],
    "documentMailbox" : ["<uri>"], // How documents are accepted in /Mailbox
    "compartment" : ["<uri>"] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : "<uri>", // C? Actual endpoint being described
    "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
      "protocol" : [{ Coding }], // http | ftp | mllp +
      "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: Schema/Schematron, Resource Profile (XML, JSON)

6.16.3.1 Terminology Bindings

PathDefinitionTypeReference
Conformance.status The lifecycle status of a Value Set or Concept MapRequiredhttp://hl7.org/fhir/conformance-resource-status
Conformance.format
Conformance.rest.security.certificate.type
The mime type of an attachmentRequiredBCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Conformance.rest.mode The mode of a RESTful conformance statementRequiredhttp://hl7.org/fhir/restful-conformance-mode
Conformance.rest.security.service Types of security services used with FHIRRequiredhttp://hl7.org/fhir/restful-security-service
Conformance.rest.resource.type
Conformance.rest.resource.searchParam.target
Conformance.messaging.event.focus
One of the resource types defined as part of FHIRRequiredhttp://hl7.org/fhir/valueset/resource-types
Conformance.rest.resource.interaction.code Operations supported by REST at the type or instance levelRequiredhttp://hl7.org/fhir/type-restful-interaction
Conformance.rest.resource.versioning How the system supports versioning for a resourceRequiredhttp://hl7.org/fhir/versioning-policy
Conformance.rest.resource.searchParam.type Data types allowed to be used for search parametersRequiredhttp://hl7.org/fhir/search-param-type
Conformance.rest.interaction.code Operations supported by REST at the system levelRequiredhttp://hl7.org/fhir/system-restful-interaction
Conformance.messaging.event.code One of the message events defined as part of FHIRPreferredhttp://hl7.org/fhir/valueset/message-events
Conformance.messaging.event.category The impact of the content of a messageRequiredhttp://hl7.org/fhir/message-significance-category
Conformance.messaging.event.mode The mode of a message conformance statementRequiredhttp://hl7.org/fhir/message-conformance-event-mode
Conformance.messaging.event.protocol The protocol used for message transportRequiredhttp://hl7.org/fhir/message-transport
Conformance.document.mode Whether the application produces or consumes documentsRequiredhttp://hl7.org/fhir/document-mode

6.16.3.2 Constraints

  • cnf-1: 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))
  • cnf-10: On Conformance.rest: A given query can only be described once per RESTful mode (xpath on f:Conformance/f:rest: count(f:query)=count(distinct-values(f:query/f:name/@value)))
  • cnf-11: On Conformance.rest.resource: Operation codes must be unique in the context of a resource (xpath on f:Conformance/f:rest/f:resource: count(f:operation)=count(distinct-values(f:operation/f:code/@value)))
  • cnf-12: On Conformance.rest.resource: Search parameter names must be unique in the context of a resource (xpath on f:Conformance/f:rest/f:resource: count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value)))
  • cnf-2: A Conformance statement SHALL have at least one of description, software, or implementation (xpath: count(f:software | f:implementation | f:description) > 0)
  • cnf-3: On Conformance.messaging: Messaging end point is required (and is only permitted) when statement is for an implementation (xpath on f:Conformance/f:messaging: exists(f:endpoint) = exists(parent::f:Conformance/f:implementation))
  • cnf-4: 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)]))
  • cnf-5: 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)))
  • cnf-6: On Conformance.messaging: The set of events per messaging endpoint must be unique by the combination of code & mode (xpath on f:Conformance/f:messaging: 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)))
  • cnf-7: 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)))
  • cnf-8: There can only be one REST declaration per mode (xpath: count(f:rest)=count(distinct-values(f:rest/f:mode/@value)))
  • cnf-9: On Conformance.rest: A given resource can only be described once per RESTful mode (xpath on f:Conformance/f:rest: count(f:resource)=count(distinct-values(f:resource/f:type/@value)))

6.16.4 Notes:

  • The Conformance resource provides for an application to describe its use of the RESTful paradigm messaging events, or FHIR documents. Usually, an application would only describe one, but more than one may be described
  • RESTful conformance rules:
    • RESTful servers are required to provide this resource on demand. Servers SHALL specify what resource types and operations are supported, and SHOULD also specify profiles for each resource type.
    • RESTful clients SHOULD publish a conformance statement
    • The search parameters that a server supports (or a client makes use of) are specified in the resource profile that the conformance statement references
    • Resource Types or operations that are not listed are not supported
  • Messaging conformance rules:
    • The interpretation of request and response 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 "receiver", 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
  • Document conformance rules:
    • Document Profiles should directly constrain the Document.information.class & type elements so so that there is no ambiguity concerning which profile any given document conforms to
  • Other service based use of resources: Due to the variability of these services, the Conformance resource does not attempt to describe service based use of resources. The various service specifications will need to describe this usage in their own way

6.16.4.1 Supporting Profiles

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.

6.16.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
datedateThe conformance statement publication dateConformance.date
descriptionstringText search in the description of the conformance statementConformance.description
eventtokenEvent code in a conformance statementConformance.messaging.event.code
fhirversiontokenThe version of FHIRConformance.version
formattokenformats supported (xml | json | mime type)Conformance.format
modetokenMode - restful (server/client) or messaging (sender/receiver)Conformance.rest.mode
namestringName of the conformance statementConformance.name
profilereferenceA profile id invoked in a conformance statementConformance.rest.resource.profile
(StructureDefinition)
publisherstringName of the publisher of the conformance statementConformance.publisher
resourcetokenName of a resource mentioned in a conformance statementConformance.rest.resource.type
securitytokenInformation about security of implementationConformance.rest.security
softwarestringPart of a the name of a software applicationConformance.software.name
statustokenThe current status of the conformance statementConformance.status
supported-profilereferenceProfiles supported by the systemConformance.profile
(StructureDefinition)
urluriThe uri that identifies the conformance statementConformance.url
versiontokenThe version identifier of the conformance statementConformance.version