AWS HealthLake · Example Payload

Describefhirdatastore

Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

HealthcareFHIRHealth DataClinical DataHIPAAInteroperabilityNLPMedicalHL7

Describefhirdatastore is an example object payload from AWS HealthLake, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

namedescriptionoperationIdrequestresponse

Example Payload

Raw ↑
{
  "name": "DescribeFHIRDatastore Example",
  "description": "<p>Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.</p>",
  "operationId": "describeFHIRDatastore",
  "request": {
    "headers": {
      "Content-Type": "application/x-amz-json-1.0",
      "X-Amz-Target": "HealthLake.DescribeFHIRDatastore",
      "X-Amz-Date": "20240115T103000Z",
      "Authorization": "AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240115/us-east-1/healthlake/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=example"
    },
    "body": {
      "DatastoreId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
    }
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "Content-Type": "application/x-amz-json-1.0"
    },
    "body": {
      "DatastoreProperties": {
        "DatastoreId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
        "DatastoreArn": "example-datastorearn",
        "DatastoreName": "my-healthlake-datastore",
        "DatastoreStatus": "CREATING",
        "CreatedAt": "2024-01-15T10:30:00Z",
        "DatastoreTypeVersion": "R4",
        "DatastoreEndpoint": "example-string",
        "SseConfiguration": {
          "KmsEncryptionConfig": {
            "CmkType": "CUSTOMER_MANAGED_KMS_KEY",
            "KmsKeyId": "example-encryptionkeyid"
          }
        },
        "PreloadDataConfig": {
          "PreloadDataType": "SYNTHEA"
        },
        "IdentityProviderConfiguration": {
          "AuthorizationStrategy": "SMART_ON_FHIR_V1",
          "FineGrainedAuthorizationEnabled": true,
          "Metadata": "example-configurationmetadat",
          "IdpLambdaArn": "example-lambdaarn"
        },
        "ErrorCause": {
          "ErrorMessage": "example-errormessage",
          "ErrorCategory": "RETRYABLE_ERROR"
        }
      }
    }
  }
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/DescribeFHIRDatastore"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.