Get the CapabilityStatement

Updated:

GET/fhir/{connection_id}/metadata

The resources, interactions and search parameters this connection's integration supports. Responses use the application/fhir+json media type; errors are OperationOutcome resources. Read-only (FHIR R4 4.0.1).

Parameters

connection_idstring required
ID of the connection

Returns

Response fieldTypeRequiredDescription
resourceTypeenumYesAlways CapabilityStatement Values: Patient, Practitioner, Encounter, Observation, Condition, AllergyIntolerance, MedicationRequest, Immunization, Bundle, OperationOutcome, CapabilityStatement
statusenumYesactive Values: active
datestringYesDate last changed
kindenumYesinstance Values: instance
softwareobjectNoSoftware that is covered by this capability statement
software.namestringYesA name the software is known by
implementationobjectNoIf this describes a specific instance
implementation.descriptionstringYesDescribes this specific instance
implementation.urlstringNoBase URL for the installation
fhirVersionstringYesFHIR Version the system supports (4.0.1)
formatstring[]Noformats supported (json, application/fhir+json)
restFhirCapabilityStatementRest[]NoIf the endpoint is a RESTful one
rest[].modeenumYesserver Values: server
rest[].documentationstringNoGeneral description of implementation
rest[].securityFhirCapabilityStatementRest_securityNoInformation about security of implementation
rest[].security.descriptionstringNoGeneral description of how security works
rest[].resourceFhirCapabilityStatementResource[]NoResource served on the REST interface
rest[].resource[].typestringYesA resource type that is supported
rest[].resource[].interactionFhirCapabilityStatementInteraction[]NoWhat operations are supported?
rest[].resource[].interaction[].codeenumYesread | search-type Values: read, search-type
rest[].resource[].searchParamFhirCapabilityStatementSearchParam[]NoSearch parameters supported by implementation
rest[].resource[].searchParam[].namestringYesName of search parameter
rest[].resource[].searchParam[].typeenumYestoken | date | reference Values: token, date, reference
rest[].resource[].searchParam[].documentationstringNoServer-specific usage

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/fhir/5de520f96e439b002043d8dc/metadata',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?