Resource Validation
Download
Focus Mode
Font Size
This document introduces the resource validation feature of Tencent Healthcare Data Services. On the Tencent Healthcare Data Services > Debugger page, you can perform resource validation operations such as search parameter validity checks.
Request Payload Parameter | Description |
Method | HTTP request method, which specifies the operation type on the FHIR server, including GET (query), POST (create), PUT (full update), PATCH (partial update), and DELETE (delete). |
Path | Request path, which locates the specific resource endpoint. |
Parameter | URL query parameters, which convey conditions such as filtering/pagination/format control in FHIR searches. |
Request Header | HTTP request header, which conveys meta-information such as content type, authentication credentials, and response format preferences within a request. |
Content | Request body, which carries resource data in operations such as POST/PUT/PATCH. |
Prerequisites
Creating an Instance has been finished.
Search Parameter Validation
For an instance with Strict Search Mode enabled during instance creation, the system validates the search parameters during a search operation.
For example, when you query patient information by ID using the correct search parameter `_id`, the query succeeds.
When you query using the incorrect search parameter `id`, the operation fails and the system prompts an unknown search parameter error.
Reference Data Integrity Validation
For an instance with the Force Quote Integrity Check feature enabled during instance creation, the system validates whether the referenced data exists during resource creation.
For example, when you create a Patient resource, the element `managingOrganization` (managing organization) references a piece of data under the Organization resource. If this data does not exist, the system returns an error indicating that the resource data cannot be found.
{ "resourceType": "Patient","id": "10001","meta": {"profile": ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"]},"identifier": [{"system": "http://example.org/mrn","value": "MRN123456"}],"active": true,"name": [{"use": "official","family": "Wang","given": ["Wu"]}],"gender": "male","birthDate": "1990-08-18","deceasedBoolean": false,"telecom": [{"system": "phone","value": "13500001111","use": "work"}],"address": [{"use": "home","type": "both","line": ["No. 100, Xinhu Road, Bao'an District, Shenzhen City, Guangdong Province"],"city": "Shenzhen","district": "Bao'an District","postalCode": "518020","country": "China"}],"managingOrganization": {"reference": "Organization/e785218b-078b-4e13-a78c-3db7a358f0a","display": "Shenzhen Hospital of Southern Medical University"}}
Repository Validation
For an instance with the Resource Library Verification feature enabled during instance creation, the system matches the rules configured in the implementation guide during resource creation. For example, if the instance's implementation guide specifies that the `gender` element of a Patient resource cannot be empty, the system returns an error indicating that resource creation failed when you create a resource with an empty value.
For example, after you comment out the `gender` element, the system returns an error during creation, indicating that the rule requires the `gender` field to be non-empty.
{"resourceType": "Patient","id":"10001","meta": {"profile": ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"]},"identifier": [{"system": "http://example.org/mrn","value": "MRN123456"}],"active": true,"name":[{"use":"official","text": "Wang Wu","family": "Wang","given": ["Wu"]}],"telecom": [{"system":"phone","value":"13500001111","use":"work"}],"gender": "male","birthDate": "1990-08-18","deceasedBoolean": false,"address": [{"use": "home","type": "both","line": ["No. 100, Xinhu Road, Bao'an District, Shenzhen City, Guangdong Province"],"city": "Shenzhen","district": "Bao'an District","postalCode": "518020","country": "China"}]}
Reference Target Type Validation
For an instance with the Force Quote Target Type Verification feature enabled during instance creation, the system validates whether the type of the referenced element complies with the standard specification during resource creation.
For example, when you create a Patient resource, the element `managingOrganization` (managing organization) is required to reference an Organization resource according to the official FHIR standard.
If you change the resource referenced by the element `managingOrganization` (managing organization) to another resource type, the system returns an error indicating that the resource type is invalid.
{"resourceType": "Patient","id": "10001","meta": {"profile": ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"]},"identifier": [{"system": "http://example.org/mrn","value": "MRN123456"}],"active": true,"name": [{"use": "official","family": "Wang","given": ["Wu"]}],"gender": "male","birthDate": "1990-08-18","deceasedBoolean": false,"telecom": [{"system": "phone","value": "13500001111","use": "work"}],"address": [{"use": "home","type": "both","line": ["No. 100, Xinhu Road, Bao'an District, Shenzhen City, Guangdong Province"],"city": "Shenzhen","district": "Bao'an District","postalCode": "518020","country": "China"}],"managingOrganization": {"reference": "Organization/e785218b-078b-4e13-a78c-3db7a358f0a","display": "Shenzhen Hospital of Southern Medical University"}}
Help and Support
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback