Conformance - FHIR Resource (dstu2)

This Conformance Resource uses the FHIR API standard for access and structure.

Validate an Conformance FHIR Resource (dstu2)

Conformance Attributes

AttributeField is listTypeDescription

Description: Profiles for use cases supported

FHIR Version: dstu2

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"profile":

Learn more about the (Conformance) profile FHIR attribute

Description: draft | active | retired

FHIR Version: dstu2

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status":

Learn more about the (Conformance) status FHIR attribute

Description: instance | capability | requirements

FHIR Version: dstu2

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"kind":

Learn more about the (Conformance) kind FHIR attribute

Description: C? Document definition

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"document":

Learn more about the (Conformance) document FHIR attribute

Description: Why is this needed?

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"requirements":

Learn more about the (Conformance) requirements FHIR attribute

Description: C? Human description of the conformance statement

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (Conformance) description FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (Conformance) copyright FHIR attribute

Description: formats supported (xml | json | mime type)

FHIR Version: dstu2

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"format":

Learn more about the (Conformance) format FHIR attribute

Description: C? If this describes a specific instance

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"implementation":

Learn more about the (Conformance) implementation FHIR attribute

Description: Name of the publisher (Organization or individual)

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher":

Learn more about the (Conformance) publisher FHIR attribute

Description: C? If the endpoint is a RESTful one

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"rest":

Learn more about the (Conformance) rest FHIR attribute

Description: Contact details of the publisher

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact":

Learn more about the (Conformance) contact FHIR attribute

Description: C? Software that is covered by this conformance statement

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"software":

Learn more about the (Conformance) software FHIR attribute

Description: Publication Date(/time)

FHIR Version: dstu2

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date":

Learn more about the (Conformance) date FHIR attribute

Description: Logical id for this version of the statement

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version":

Learn more about the (Conformance) version FHIR attribute

Description: Logical uri to reference this statement

FHIR Version: dstu2

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url":

Learn more about the (Conformance) url FHIR attribute

Description: FHIR Version the system uses

FHIR Version: dstu2

Attribute Type : id

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"fhirVersion":

Learn more about the (Conformance) fhirVersion FHIR attribute

Description: C? If messaging is supported

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"messaging":

Learn more about the (Conformance) messaging FHIR attribute

Description: no | extensions | elements | both

FHIR Version: dstu2

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"acceptUnknown":

Learn more about the (Conformance) acceptUnknown FHIR attribute

Description: If for testing purposes, not real usage

FHIR Version: dstu2

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental":

Learn more about the (Conformance) experimental FHIR attribute

Description: Informal name for this conformance statement

FHIR Version: dstu2

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name":

Learn more about the (Conformance) name FHIR attribute

Conformance Structure


  
{
  "resourceType" : "Conformance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical uri to reference this statement
  "version" : "<string>", // Logical id for this version of the statement
  "name" : "<string>", // Informal name for this conformance statement
  "status" : "<code>", // draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "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
  }],
  "date" : "<dateTime>", // R!  Publication Date(/time)
  "description" : "<string>", // C? Human description of the conformance statement
  "requirements" : "<string>", // Why is this needed?
  "copyright" : "<string>", // Use and/or publishing restrictions
  "kind" : "<code>", // R!  instance | capability | requirements
  "software" : { // C? Software that is covered by this conformance statement
    "name" : "<string>", // R!  A name the software is known by
    "version" : "<string>", // Version covered by this statement
    "releaseDate" : "<dateTime>" // Date this version released
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<uri>" // Base URL for the installation
  },
  "fhirVersion" : "<id>", // R!  FHIR Version the system uses
  "acceptUnknown" : "<code>", // R!  no | extensions | elements | both
  "format" : ["<code>"], // R!  formats supported (xml | json | mime type) 
  "profile" : [{ Reference(StructureDefinition) }], // Profiles for use cases supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<string>", // General description of implementation
    "security" : { // Information about security of implementation
      "cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/)
      "service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
      "description" : "<string>", // General description of how security works
      "certificate" : [{ // Certificates associated with security profiles
        "type" : "<code>", // Mime type for certificate 
        "blob" : "<base64Binary>" // Actual certificate
      }]
    },
    "resource" : [{ // R!  Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { Reference(StructureDefinition) }, // Base System profile for all uses of resource
      "interaction" : [{ // R!  What operations are supported?
        "code" : "<code>", // R!  read | vread | update | delete | history-instance | 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" : "<code>", // not-supported | single | multiple - how conditional delete is supported
      "searchInclude" : ["<string>"], // _include values supported by the server
      "searchRevInclude" : ["<string>"], // _revinclude values supported by the server
      "searchParam" : [{ // Search params supported by implementation
        "name" : "<string>", // R!  Name of search parameter
        "definition" : "<uri>", // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
        "documentation" : "<string>", // Server-specific usage
        "target" : ["<code>"], // Types of resource (if a resource reference)
        "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type
        "chain" : ["<string>"] // Chained names supported
      }]
    }],
    "interaction" : [{ // What operations are supported?
      "code" : "<code>", // R!  transaction | search-system | history-system
      "documentation" : "<string>" // Anything special about operation behavior
    }],
    "transactionMode" : "<code>", // not-supported | batch | transaction | both
    "searchParam" : [{ Content as for Conformance.rest.resource.searchParam }], // Search params for searching all resources
    "operation" : [{ // Definition of an operation or a custom query
      "name" : "<string>", // R!  Name by which the operation/query is invoked
      "definition" : { Reference(OperationDefinition) } // R!  The defined operation/query
    }],
    "compartment" : ["<uri>"] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : [{ // A messaging service end-point
      "protocol" : { Coding }, // R!  http | ftp | mllp +
      "address" : "<uri>" // R!  Address of end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<string>", // Messaging interface behavior details
    "event" : [{ // R!  Declare support for this event
      "code" : { Coding }, // R!  Event type
      "category" : "<code>", // Consequence | Currency | Notification
      "mode" : "<code>", // R!  sender | receiver
      "focus" : "<code>", // R!  Resource that's focus of message
      "request" : { Reference(StructureDefinition) }, // R!  Profile that describes the request
      "response" : { Reference(StructureDefinition) }, // R!  Profile that describes the response
      "documentation" : "<string>" // Endpoint-specific event documentation
    }]
  }],
  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<string>", // Description of document support
    "profile" : { Reference(StructureDefinition) } // R!  Constraint on a resource used in the document
  }]
}

Conformance Search Parameters

The following search parameters can be used to query Conformance resources. Just submit them like so:

https://api.1up.health/fhir/dstu2/Conformance?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`date`	`date`	`date`
`description`	`text`	`description`
`event`	`text`	`messaging.event.code`
`fhirversion`	`text`	`version`
`format`	`text`	`format`
`mode`	`text`	`rest.mode`
`name`	`text`	`name`
`profile`	`reference`	`rest.resource.profile`
`publisher`	`text`	`publisher`
`resource`	`text`	`rest.resource.type`
`security`	`text`	`rest.security.service`
`software`	`text`	`software.name`
`status`	`text`	`status`
`supported-profile`	`reference`	`profile`
`url`	`uri`	`url`
`version`	`text`	`version`