CapabilityStatement - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
acceptUnknownfalsecode no | extensions | elements | both
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown C? Natural language description of the capability statement
documenttrueData Type C? Document definition
experimentalfalseboolean For testing purposes, not real usage
fhirVersionfalseid FHIR Version the system uses
formattruecode formats supported (xml | json | ttl | mime type)
implementationfalseData Type C? If this describes a specific instance
implementationGuidetrueuri Implementation guides supported
instantiatestrueuri Canonical URL of another capability statement this implements
jurisdictiontrueCodeableConcept Intended jurisdiction for capability statement (if applicable)
kindfalsecode instance | capability | requirements
messagingtrueData Type C? If messaging is supported
namefalsestring Name for this capability statement (computer friendly)
patchFormattruecode Patch formats supported
profiletrueReference Profiles for use cases 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 Logical URI to reference this capability statement (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the capability statement

CapabilityStatement Example

{
  "profile": [
    {
      "reference": "http://hl7.org/fhir/us/core/StructureDefinition/familymemberhistory-genetic"
    }
  ],
  "patchFormat": [
    "application/xml-patch+xml",
    "application/json-patch+json"
  ],
  "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>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "US",
          "system": "urn:iso:std:iso:3166",
          "display": "United States of America (the)"
        }
      ]
    }
  ],
  "rest": [
    {
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "history-system"
        }
      ],
      "resource": [
        {
          "profile": {
            "reference": "http://fhir.hl7.org/base/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416"
          },
          "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"
            }
          ],
          "conditionalDelete": "not-supported",
          "documentation": "This server does not let the clients create identities.",
          "searchInclude": [
            "Organization"
          ],
          "searchRevInclude": [
            "Person"
          ],
          "conditionalRead": "full-support",
          "searchParam": [
            {
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "documentation": "Only supports search by institution MRN",
              "type": "token",
              "name": "identifier"
            },
            {
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
              "type": "reference",
              "name": "general-practitioner"
            }
          ],
          "readHistory": true,
          "updateCreate": false,
          "conditionalUpdate": false,
          "type": "Patient",
          "conditionalCreate": true,
          "versioning": "versioned-update"
        }
      ],
      "documentation": "Main FHIR endpoint for acem health",
      "mode": "server",
      "security": {
        "certificate": [
          {
            "type": "application/jwt",
            "blob": "IHRoaXMgYmxvYiBpcyBub3QgdmFsaWQ="
          }
        ],
        "description": "See Smart on FHIR documentation",
        "service": [
          {
            "coding": [
              {
                "code": "SMART-on-FHIR",
                "system": "http://hl7.org/fhir/restful-security-service"
              }
            ]
          }
        ],
        "cors": true
      },
      "compartment": [
        "http://hl7.org/fhir/CompartmentDefinition/patient"
      ]
    }
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/lab"
  ],
  "id": "example",
  "copyright": "Copyright © Acme Healthcare and GoodCorp EHR Systems",
  "title": "ACME EHR capability statement",
  "implementation": {
    "url": "http://10.2.3.4/fhir",
    "description": "main EHR at ACME"
  },
  "version": "20130510",
  "acceptUnknown": "both",
  "status": "draft",
  "description": "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface",
  "fhirVersion": "1.0.0",
  "format": [
    "xml",
    "json"
  ],
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "positive",
            "system": "http://hl7.org/fhir/variant-state"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    }
  ],
  "purpose": "Main EHR capability statement, published for contracting and operational support",
  "date": "2012-01-04",
  "instantiates": [
    "http://ihe.org/fhir/CapabilityStatement/pixm-client"
  ],
  "publisher": "ACME Corporation",
  "kind": "instance",
  "document": [
    {
      "profile": {
        "reference": "http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796"
      },
      "documentation": "Basic rules for all documents in the EHR system",
      "mode": "consumer"
    }
  ],
  "name": "ACME-EHR",
  "resourceType": "CapabilityStatement",
  "url": "urn:uuid:68D043B5-9ECF-4559-A57A-396E0D452311",
  "contact": [
    {
      "telecom": [
        {
          "system": "email",
          "value": "wile@acme.org"
        }
      ],
      "name": "System Administrator"
    }
  ],
  "messaging": [
    {
      "reliableCache": 30,
      "endpoint": [
        {
          "protocol": {
            "code": "mllp",
            "system": "http://hl7.org/fhir/message-transport"
          },
          "address": "mllp:10.1.1.10:9234"
        }
      ],
      "event": [
        {
          "category": "Consequence",
          "code": {
            "code": "admin-notify",
            "system": "http://hl7.org/fhir/message-events"
          },
          "documentation": "Notification of an update to a patient resource. changing the links is not supported",
          "request": {
            "reference": "StructureDefinition/Patient"
          },
          "focus": "Patient",
          "mode": "receiver",
          "response": {
            "reference": "StructureDefinition/MessageHeader"
          }
        }
      ],
      "documentation": "ADT A08 equivalent for external system notifications"
    }
  ],
  "experimental": true,
  "software": {
    "releaseDate": "2012-01-04",
    "version": "0.00.020.2134",
    "name": "EHR"
  }
}

CapabilityStatement Structure


  
{
  "resourceType" : "CapabilityStatement",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this capability statement (globally unique)
  "version" : "<string>", // Business version of the capability statement
  "name" : "<string>", // 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 this was 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 }], // Context 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>", // R!  instance | capability | requirements
  "instantiates" : ["<uri>"], // Canonical URL of another capability statement this implements
  "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 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 | ttl | mime type) 
  "patchFormat" : ["<code>"], // Patch formats supported 
  "implementationGuide" : ["<uri>"], // Implementation guides supported
  "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 certificates 
        "blob" : "<base64Binary>" // Actual certificate
      }]
    },
    "resource" : [{ // 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
      "documentation" : "<markdown>", // Additional information about the use of the resource type
      "interaction" : [{ // R!  What operations are supported?
        "code" : "<code>", // R!  read | vread | update | patch | delete | history-instance | 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
      "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" : "<uri>", // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
        "documentation" : "<string>" // Server-specific usage
      }]
    }],
    "interaction" : [{ // What operations are supported?
      "code" : "<code>", // R!  transaction | batch | search-system | history-system
      "documentation" : "<string>" // Anything special about operation behavior
    }],
    "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters 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" : [{ // Where messages should be sent
      "protocol" : { Coding }, // R!  http | ftp | mllp +
      "address" : "<uri>" // R!  Network address or identifier of the end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<string>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : { Reference(MessageDefinition) } // R!  Message supported by this system
    }],
    "event" : [{ // 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
  }]
}


 

CapabilityStatement Search Parameters

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

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