Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.Resource-validate
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store.
Implements the FHIR extended operation $validate (DSTU2, STU3, R4, or R5).
The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The Parameters input syntax is not supported.
The profile query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned.
Errors generated by validation contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
HTTP request
POST https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}/$validate
Required. The name of the FHIR store that holds the profiles being used for validation.
Authorization requires the following IAM permission on the specified resource parent:
healthcare.fhirResources.get
type
string
Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4, or R5). Must match the resource type in the provided content.
Query parameters
Parameters
profile
string
Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient. A StructureDefinition with this canonical URL must exist in the FHIR store.
Request body
The request body contains an instance of HttpBody.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-23 UTC."],[[["\u003cp\u003eThis endpoint validates a FHIR resource against its profiles and those configured on the FHIR store, using the $validate operation defined in FHIR standards (DSTU2, STU3, or R4).\u003c/p\u003e\n"],["\u003cp\u003eRequests must include a JSON-encoded FHIR resource in the body and set the \u003ccode\u003eContent-Type\u003c/code\u003e header to \u003ccode\u003eapplication/fhir+json\u003c/code\u003e, while also using the HTTP \u003ccode\u003ePOST\u003c/code\u003e method at the specified URL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprofile\u003c/code\u003e query parameter allows specifying a particular profile URL for validation, which must be present in the FHIR store, otherwise it will return an error.\u003c/p\u003e\n"],["\u003cp\u003eValidation errors are detailed in a JSON-encoded \u003ccode\u003eOperationOutcome\u003c/code\u003e resource, while general API errors are reported as standard GCP errors.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires the \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permission on the parent FHIR store and one of the following OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
