CapabilityStatement - FHIR Resource (r4)


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

Validate an CapabilityStatement FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
descriptionfalsemarkdown# C? Natural language description of the capability statement
documenttrueData Type# C? Document definition
experimentalfalseboolean# For testing purposes, not real usage
fhirVersionfalsecode# FHIR Version the system supports
formattruecode# formats supported (xml | json | ttl | mime type)
implementationfalseData Type# C? If this describes a specific instance
implementationGuidetruecanonical(ImplementationGuide)# Implementation guides supported
importstruecanonical(CapabilityStatement)# Canonical URL of another capability statement this adds to
instantiatestruecanonical(CapabilityStatement)# Canonical URL of another capability statement this implements
jurisdictiontrueCodeableConcept# Intended jurisdiction for capability statement (if applicable)
kindfalsecode# C? instance | capability | requirements
messagingtrueData Type# C? If messaging is supported
namefalsestring# C? Name for this capability statement (computer friendly)
patchFormattruecode# Patch formats supported
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this capability statement is defined
resttrueData Type# C? If the endpoint is a RESTful one
softwarefalseData Type# C? Software that is covered by this capability statement
statusfalsecode# draft | active | retired | unknown
titlefalsestring# Name for this capability statement (human friendly)
urlfalseuri# Canonical identifier for this capability statement, represented as a URI (globally unique)
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the capability statement

CapabilityStatement Example

{
  "resourceType": "CapabilityStatement",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>The EHR Server supports the following transactions for the resource Person: read, vread, \n        update, history, search(name,gender), create and updates.</p>\n\t\t\t<p>The EHR System supports the following message: admin-notify::Person.</p>\n\t\t\t<p>The EHR Application has a \n        <a href=\"http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796\">general document profile</a>.\n      </p>\n\t\t</div>"
  },
  "url": "urn:uuid:68D043B5-9ECF-4559-A57A-396E0D452311",
  "version": "20130510",
  "name": "ACME-EHR",
  "title": "ACME EHR capability statement",
  "status": "draft",
  "experimental": true,
  "date": "2012-01-04",
  "publisher": "ACME Corporation",
  "contact": [
    {
      "name": "System Administrator",
      "telecom": [
        {
          "system": "email",
          "value": "wile@acme.org"
        }
      ]
    }
  ],
  "description": "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/variant-state",
            "code": "positive"
          }
        ]
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America (the)"
        }
      ]
    }
  ],
  "purpose": "Main EHR capability statement, published for contracting and operational support",
  "copyright": "Copyright © Acme Healthcare and GoodCorp EHR Systems",
  "kind": "instance",
  "instantiates": [
    "http://ihe.org/fhir/CapabilityStatement/pixm-client"
  ],
  "software": {
    "name": "EHR",
    "version": "0.00.020.2134",
    "releaseDate": "2012-01-04"
  },
  "implementation": {
    "description": "main EHR at ACME",
    "url": "http://10.2.3.4/fhir"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/xml-patch+xml",
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/lab"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Main FHIR endpoint for acem health",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ],
        "description": "See Smart on FHIR documentation"
      },
      "resource": [
        {
          "type": "Patient",
          "profile": "http://registry.fhir.org/r4/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416",
          "supportedProfile": [
            "http://registry.fhir.org/r4/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347"
          ],
          "documentation": "This server does not let the clients create identities.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread",
              "documentation": "Only supported for patient records since 12-Dec 2012"
            },
            {
              "code": "update"
            },
            {
              "code": "history-instance"
            },
            {
              "code": "create"
            },
            {
              "code": "history-type"
            }
          ],
          "versioning": "versioned-update",
          "readHistory": true,
          "updateCreate": false,
          "conditionalCreate": true,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "Organization"
          ],
          "searchRevInclude": [
            "Person"
          ],
          "searchParam": [
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "Only supports search by institution MRN"
            },
            {
              "name": "general-practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
              "type": "reference"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "history-system"
        }
      ],
      "compartment": [
        "http://hl7.org/fhir/CompartmentDefinition/patient"
      ]
    }
  ],
  "messaging": [
    {
      "endpoint": [
        {
          "protocol": {
            "system": "http://terminology.hl7.org/CodeSystem/message-transport",
            "code": "mllp"
          },
          "address": "mllp:10.1.1.10:9234"
        }
      ],
      "reliableCache": 30,
      "documentation": "ADT A08 equivalent for external system notifications",
      "supportedMessage": [
        {
          "mode": "receiver",
          "definition": "MessageDefinition/example"
        }
      ]
    }
  ],
  "document": [
    {
      "mode": "consumer",
      "documentation": "Basic rules for all documents in the EHR system",
      "profile": "http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796"
    }
  ]
}

CapabilityStatement Structure

{
  "resourceType" : "CapabilityStatement",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this capability statement, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the capability statement
  "name" : "<string>", // C? Name for this capability statement (computer friendly)
  "title" : "<string>", // Name for this capability statement (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // C? Natural language description of the capability statement
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable)
  "purpose" : "<markdown>", // Why this capability statement is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "instantiates" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this implements
  "imports" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this adds to
  "software" : { // C? Software that is covered by this capability statement
    "name" : "<string>", // R!  A name the software is known by
    "version" : "<string>", // Version covered by this statement
    "releaseDate" : "<dateTime>" // Date this version was released
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>", // Base URL for the installation
    "custodian" : { Reference(Organization) } // Organization that manages the data
  },
  "fhirVersion" : "<code>", // R!  FHIR Version the system supports
  "format" : ["<code>"], // R!  formats supported (xml | json | ttl | mime type)
  "patchFormat" : ["<code>"], // Patch formats supported
  "implementationGuide" : [{ canonical(ImplementationGuide) }], // Implementation guides supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<markdown>", // 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" : "<markdown>" // General description of how security works
    },
    "resource" : [{ // Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { canonical(StructureDefinition) }, // Base System profile for all uses of resource
      "supportedProfile" : [{ canonical(StructureDefinition) }], // Profiles for use cases supported
      "documentation" : "<markdown>", // Additional information about the use of the resource type
      "interaction" : [{ // What operations are supported?
        "code" : "<code>", // R!  read | vread | update | patch | delete | history-instance | history-type | create | search-type
        "documentation" : "<markdown>" // 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
      "conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support
      "conditionalUpdate" : <boolean>, // If allows/uses conditional update
      "conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
      "referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local
      "searchInclude" : ["<string>"], // _include values supported by the server
      "searchRevInclude" : ["<string>"], // _revinclude values supported by the server
      "searchParam" : [{ // Search parameters supported by implementation
        "name" : "<string>", // R!  Name of search parameter
        "definition" : { canonical(SearchParameter) }, // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special
        "documentation" : "<markdown>" // Server-specific usage
      }],
      "operation" : [{ // Definition of a resource operation
        "name" : "<string>", // R!  Name by which the operation/query is invoked
        "definition" : { canonical(OperationDefinition) }, // R!  The defined operation/query
        "documentation" : "<markdown>" // Specific details about operation behavior
      }]
    }],
    "interaction" : [{ // What operations are supported?
      "code" : "<code>", // R!  transaction | batch | search-system | history-system
      "documentation" : "<markdown>" // Anything special about operation behavior
    }],
    "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources
    "operation" : [{ Content as for CapabilityStatement.rest.resource.operation }], // Definition of a system level operation
    "compartment" : [{ canonical(CompartmentDefinition) }] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : [{ // Where messages should be sent
      "protocol" : { Coding }, // R!  http | ftp | mllp +
      "address" : "<url>" // R!  Network address or identifier of the end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<markdown>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : { canonical(MessageDefinition) } // R!  Message supported by this system
    }]
  }],
  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<markdown>", // Description of document support
    "profile" : { canonical(StructureDefinition) } // R!  Constraint on the resources used in the document
  }]
}

CapabilityStatement Search Parameters

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

https://api.1up.health/fhir/r4/CapabilityStatement?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
context TUtextuseContext.value
context-quantity TUquantityuseContext.value
context-type TUtextuseContext.code
context-type-quantity TUcompositeuseContext
context-type-value TUcompositeuseContext
date TUdatedate
description TUtextdescription
fhirversion TUtextversion
format TUtextformat
guide TUreferenceimplementationGuide
jurisdiction TUtextjurisdiction
mode TUtextrest.mode
name TUtextname
publisher TUtextpublisher
resource TUtextrest.resource.type
resource-profile TUreferencerest.resource.profile
security-service TUtextrest.security.service
software TUtextsoftware.name
status TUtextstatus
supported-profile TUreferencerest.resource.supportedProfile
title TUtexttitle
url TUuriurl
version TUtextversion