Module health.fhir.r4.parser
ballerinax/health.fhir.r4.parser Ballerina library
FHIR Parser Package
FHIR Parser is a package facilitates to read, validate, and convert FHIR resources among their serialized formats and structured in-memory representations.
Package Overview
This package provides the following functionalities required for parsing FHIR resource payloads to corresponding FHIR resource models.
-
Serialization: FHIR resources can be serialized to JSON.
-
Validation: The parser performs validation checks to ensure that the parsed resource adheres to the FHIR specification's rules and constraints.
-
In-Memory Representation: The parser creates an in-memory representation of the resource as a data model from Ballerina FHIR IG packages (i.e health.fhir.r4, health.fhir.r4.uscore501, etc.).
Refer API Documentation for sample usage.
Functions
createValidationError
function createValidationError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, FHIRErrorTypes? errorType, string[]? parsedErrors, int httpStatusCode) returns FHIRErrorUtility function to create FHIRError for validator.
Parameters
- message string - Message to be added to the error
- errServerity Severity - serverity of the error
- code IssueType - error code
- diagnostic string? (default ()) - (optional) diagnostic message
- expression string[]? (default ()) - (optional) FHIR Path expression to the error location
- cause error? (default ()) - (optional) original error
- errorType FHIRErrorTypes? (default ()) - (optional) type of the error
- parsedErrors string[]? (default ()) - (optional) usefriendly error messages parsed from original error message
- httpStatusCode int (default http:STATUS_INTERNAL_SERVER_ERROR) - (optional) [default: 500] HTTP status code to return to the client
Return Type
- FHIRError - Return Value Description
parse
function parse(json|xml|string payload, typedesc<anydata>? targetFHIRModelType, string? targetProfile) returns anydata|FHIRParseErrorFunction to parse FHIR Payload into FHIR Resource model. Note : When using inside FHIR templates, use ballerinax/health.fhir.r4.parser module instead of this.
Parameters
- targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to parse. Derived from payload if not given
- targetProfile string? (default ()) - (Optional) target profile to parse. Derived from payload if not given
Return Type
- anydata|FHIRParseError - returns FHIR model (Need to cast to relevant type by the caller). FHIRParseError if error ocurred
parseConstraintErrors
Parameters
- message string -
parseWithValidation
function parseWithValidation(json|xml|string payload, typedesc<anydata>? targetFHIRModelType, string? targetProfile) returns anydata|FHIRValidationError|FHIRParseErrorFunction to validate and parse FHIR resource payload.
Parameters
- targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to parse. Derived from payload if not given.
- targetProfile string? (default ()) - (Optional) target profile to parse. Derived from payload if not given.
Return Type
- anydata|FHIRValidationError|FHIRParseError - Record representation of the FHIR resource if success. Otherwise, return validation error.
validate
function validate(anydata data) returns FHIRValidationError?This method will validate FHIR resource. Validation consist of Structure, cardinality, Value domain, Profile, json.
Parameters
- data anydata - FHIR resource
Return Type
- FHIRValidationError? - If the validation fails, return validation error
validateAndParse
function validateAndParse(json|xml payload, ResourceAPIConfig apiConfig) returns anydata|FHIRValidationError|FHIRParseError?Function to validate against API Config and parse FHIR resource payload.
Parameters
- payload json|xml - FHIR resource payload
- apiConfig ResourceAPIConfig - APIConfig of the FHIR resource API
Return Type
- anydata|FHIRValidationError|FHIRParseError? - Record representation of the FHIR resource if success.
Records
health.fhir.r4.parser: FHIRValidationIssueDetail
Record used to store user friendly error messages.
Fields
- detailedErrors string[]?(default ()) - User friendly error messages