Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1376177324.7 KB
projects

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.

post/v1/{+parent}/fhir/{+type}/$validate

Path parameters

parentstring required

Required. The name of the FHIR store that holds the profiles being used for validation.

typestring required

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

profilestring

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

extensionsobject[]

Application specific response metadata. Must be set in the first response for streaming APIs.

datastring byte

The HTTP request/response body as raw binary.

contentTypestring

The HTTP Content-Type header value specifying the content type of the body.

Response

Successful response