Conformance - FHIR Resource (dstu2)


Resource Attributes

AttributeField is listTypeDescription
acceptUnknownfalsecode no | extensions | elements | both
contacttrueData Type Contact details of the publisher
copyrightfalsestring Use and/or publishing restrictions
datefalsedateTime Publication Date(/time)
descriptionfalsestring C? Human description of the conformance statement
documenttrueData Type C? Document definition
experimentalfalseboolean If for testing purposes, not real usage
fhirVersionfalseid FHIR Version the system uses
formattruecode formats supported (xml | json | mime type)
implementationfalseData Type C? If this describes a specific instance
kindfalsecode instance | capability | requirements
messagingtrueData Type C? If messaging is supported
namefalsestring Informal name for this conformance statement
profiletrueReference Profiles for use cases supported
publisherfalsestring Name of the publisher (Organization or individual)
requirementsfalsestring Why is this needed?
resttrueData Type C? If the endpoint is a RESTful one
softwarefalseData Type C? Software that is covered by this conformance statement
statusfalsecode draft | active | retired
urlfalseuri Logical uri to reference this statement
versionfalsestring Logical id for this version of the statement

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 the like so:

https://api.1up.health/fhir/dstu2/Conformance?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedatedate
descriptiontextdescription
eventtextmessaging.event.code
fhirversiontextversion
formattextformat
modetextrest.mode
nametextname
profilereferencerest.resource.profile
publishertextpublisher
resourcetextrest.resource.type
securitytextrest.security.service
softwaretextsoftware.name
statustextstatus
supported-profilereferenceprofile
urluriurl
versiontextversion