Releasesv0.1.0
Api referenceEndpointsFhir

The FHIR R4 CapabilityStatement of the user's FHIR base

GET
/v1/users/{id}/fhir/metadata

What the FHIR routes serve (read only), as a CapabilityStatement.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The CapabilityStatement.

application/fhir+json
  1. response

What the FHIR routes serve, as a FHIR R4 CapabilityStatement.

resourceType*string
status*string
date*string
kind*string
implementation?
fhirVersion*string
format*array<string>
rest*array<>
curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/fhir/metadata' \  -H 'Authorization: Bearer ohs_sk_...'
{  "resourceType": "CapabilityStatement",  "status": "active",  "date": "string",  "kind": "instance",  "implementation": {    "description": "string",    "url": "http://example.com"  },  "fhirVersion": "4.0.1",  "format": [    "string"  ],  "rest": [    {      "mode": "server",      "security": {        "description": "string"      },      "resource": [        {          "type": "string",          "interaction": [            {              "code": "string"            }          ],          "searchParam": [            {              "name": "string",              "definition": "http://example.com",              "type": "string",              "documentation": "string"            }          ],          "operation": [            {              "name": "string",              "definition": "http://example.com"            }          ]        }      ]    }  ]}
Edit on GitHub