AWS HealthLake · Example Payload

Listfhirdatastores

Lists all FHIR data stores that are in the user’s account, regardless of data store status.

HealthcareFHIRHealth DataClinical DataHIPAAInteroperabilityNLPMedicalHL7

Listfhirdatastores 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

{
  "name": "ListFHIRDatastores Example",
  "description": "<p>Lists all FHIR data stores that are in the user\u2019s account, regardless of data store status.</p>",
  "operationId": "listFHIRDatastores",
  "request": {
    "headers": {
      "Content-Type": "application/x-amz-json-1.0",
      "X-Amz-Target": "HealthLake.ListFHIRDatastores",
      "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": {
      "Filter": {
        "DatastoreName": "my-healthlake-datastore",
        "DatastoreStatus": "CREATING",
        "CreatedBefore": "2024-01-15T10:30:00Z",
        "CreatedAfter": "2024-01-15T10:30:00Z"
      },
      "NextToken": "example-nexttoken",
      "MaxResults": 1
    }
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "Content-Type": "application/x-amz-json-1.0"
    },
    "body": {
      "DatastorePropertiesList": [
        {
          "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": "example-string",
              "KmsKeyId": "example-string"
            }
          },
          "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
          },
          "IdentityProviderConfiguration": {
            "AuthorizationStrategy": "SMART_ON_FHIR_V1",
            "FineGrainedAuthorizationEnabled": true,
            "Metadata": "example-configurationmetadat",
            "IdpLambdaArn": "example-lambdaarn"
          },
          "ErrorCause": {
            "ErrorMessage": "example-errormessage",
            "ErrorCategory": "RETRYABLE_ERROR"
          }
        }
      ],
      "NextToken": "example-nexttoken"
    }
  }
}