ballerinax / health.fhir.r4 Ballerina library

FHIR validation related error

health.fhir.r4: FHIRProcessingError

FHIR processing related issue related error

health.fhir.r4: FHIRSerializerError

FHIR serializer error

health.fhir.r4: FHIRTypeError

FHIR data/resource type related error

health.fhir.r4: FHIRValidationError

CodeableConcept|Quantity|Range|Reference

FHIR validation related error

Object types

health.fhir.r4: FhirAnalyticsPublisher

FhirAnalyticsPublisher interface defines the contract for all analytics publisher implementations. Each implementation must provide its own logic for publishing analytics data.

publish

Isolated Function

function publish(map<string[]> requestHeaders, json|ClientError requestPayload, map<string[]> responseHeaders, json|ClientError responsePayload, int statusCode, string requestPath) returns error?

Publishes the analytics data to the configured destination

Parameters

requestHeaders map<string[]> - The HTTP request headers

requestPayload json|ClientError - The HTTP request payload

responseHeaders map<string[]> - The HTTP response headers

responsePayload json|ClientError - The HTTP response payload

statusCode int - The HTTP status code of the response

requestPath string - The request path of the API call

Return Type

error? - An error if the publishing fails

health.fhir.r4: TerminologyLoader

Distinct

Terminology loader definition

load

function load() returns Terminology|FHIRError

Union types

health.fhir.r4: Extension

Extension

health.fhir.r4: UsageContextValueX

UsageContextValueX

health.fhir.r4: FHIRWireFormat

xml|json

FHIRWireFormat

FHIR wire content type formats

health.fhir.r4: AnyBaseResource

CodeSystem|ValueSet

AnyBaseResource

Aggregated type of all resource type in this IG

Intersection types

health.fhir.r4: Terminology

readonly & TerminologyRecord

Terminology

Record type ro represent terminology

health.fhir.r4: ResourceAPIConfig

readonly & ResourceAPIConfigType

ResourceAPIConfig

Redefined FHIR read-only FHIR resource API config

Function types

health.fhir.r4: OperationPreProcessor

 function(FHIROperationDefinition, string, map<string[]?>?, json|xml?) returns (map<RequestSearchParameter[]>|FHIRResourceEntity|FHIRError?)

OperationPreProcessor

Function type to be implemented to override the operation pre-processing

health.fhir.r4: OperationPostProcessor

function(FHIROperationDefinition, FHIRContext) returns (FHIRError?)

OperationPostProcessor

Function type to be implemented to override the operation post-processing

health.fhir.r4: CodeSystemFinder

function(uri, code) returns (CodeSystem|ValueSet|FHIRError)

CodeSystemFinder

Function definition for code system finder implementations

health.fhir.r4: DataTypeSerializerFunction

function(anydata, ElementAnnotationDefinition) returns ((FHIRWireFormat|FHIRSerializerError)?)

DataTypeSerializerFunction

Function definition for data type serialization

health.fhir.r4: ResourceSerializerFunction

function(anydata) returns ((FHIRWireFormat|FHIRSerializerError)?)

ResourceSerializerFunction

Function definition for FHIR resource serialization

health.fhir.r4: ContainerSerializerFunction

function(Bundle) returns ((FHIRWireFormat|FHIRSerializerError)?)

ContainerSerializerFunction

Function definition for FHIR container resource serialization

health.fhir.r4: DataTypeValidationFunction

function(anydata, ElementAnnotationDefinition) returns (FHIRValidationError?)

DataTypeValidationFunction

Function definition for FHIR data type validation

health.fhir.r4: ResourceTypeValidationFunction

function(anydata) returns (FHIRValidationError?)

ResourceTypeValidationFunction

Function definition for FHIR resource validation

health.fhir.r4: SearchParameterPreProcessor

function(FHIRSearchParameterDefinition, string, RequestQueryParameter) returns (RequestSearchParameter[]|FHIRError)

SearchParameterPreProcessor

Function type to be implemented to override the search parameter pre-processing

health.fhir.r4: SearchParameterPostProcessor

function(FHIRSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)

SearchParameterPostProcessor

Function type to be implemented to override the search parameter post-processing

health.fhir.r4: CommonSearchParameterPreProcessor

 function(CommonSearchParameterDefinition, RequestQueryParameter, ResourceAPIConfig) returns (RequestSearchParameter[]|FHIRError)

CommonSearchParameterPreProcessor

common search parameter pre processor function

health.fhir.r4: CommonSearchParameterPostProcessor

function(CommonSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)

CommonSearchParameterPostProcessor

common search parameter post processor function

health.fhir.r4: SearchParameterDefaultValueProcessor

function(CommonSearchParameterDefinition, ResourceAPIConfig) returns (anydata|FHIRError?)

SearchParameterDefaultValueProcessor

String types

health.fhir.r4: uri

uri

A Uniform Resource Identifier Reference (RFC 3986 ). Note: URIs are case sensitive. For UUID (urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all lowercase

Regex: \S* (This regex is very permissive, but URIs must be valid. Implementers are welcome to use more specific regex statements for a URI in specific contexts)

health.fhir.r4: canonical

canonical

A URI that refers to a resource by its canonical URL (resources with a url property). The canonical type differs from a uri in that it has special meaning in this specification, and in that it may have a version appended, separated by a vertical bar (|). Note that the type canonical is not used for the actual canonical URLs that are the target of these references, but for the URIs that refer to them, and may have the version suffix in them. Like other URIs, elements of type canonical may also have #fragment references

health.fhir.r4: base64Binary

base64Binary

A stream of bytes, base64 encoded (RFC 4648 )

Regex: (\s*([0-9a-zA-Z\+\=]){4}\s*)+

health.fhir.r4: instant

instant

An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time SHALL specified at least to the second and SHALL include a time zone. Note: This is intended for when precisely observed times are required (typically system logs etc.), and not human-reported times - for those, use date or dateTime (which can be as precise as instant, but is not required to be). instant is a more constrained dateTime.

Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))

health.fhir.r4: date

date

A date, or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, or YYYY-MM-DD, e.g. 2018, 1973-06, or 1905-08-23. There SHALL be no time zone. Dates SHALL be valid dates

Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?

health.fhir.r4: dateTime

dateTime

A date, date-time or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+zz:zz, e.g. 2018, 1973-06, 1905-08-23, 2015-02-07T13:28:17-05:00 or 2017-01-01T00:00:00.000Z. If hours and minutes are specified, a time zone SHALL be populated. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion. Dates SHALL be valid dates. The time "24:00" is not allowed. Leap Seconds are allowed.

Regex: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?

health.fhir.r4: time

time

A time during the day, in the format hh:mm:ss. There is no date specified. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion. The time "24:00" SHALL NOT be used. A time zone SHALL NOT be present. Times can be converted to a Duration since midnight.

Regex: ([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?

health.fhir.r4: code

code

Indicates that the value is taken from a set of controlled strings defined elsewhere (see Using codes for further discussion). Technically, a code is restricted to a string which has at least one character and no leading or trailing whitespace, and where there is no whitespace other than single spaces in the contents

Regex: [^\s]+(\s[^\s]+)*

health.fhir.r4: oid

oid

An OID represented as a URI (RFC 3001 ); e.g. urn:oid:1.2.3.4.5

Regex: urn:oid:[0-2](\.(0|[1-9][0-9]*))+

health.fhir.r4: id

Any combination of upper- or lower-case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)

Regex: [A-Za-z0-9\-\.]{1,64}

health.fhir.r4: markdown

markdown

A FHIR string that may contain markdown syntax for optional processing by a markdown presentation engine, in the GFM extension of CommonMark format

health.fhir.r4: uuid

uuid

A UUID (aka GUID) represented as a URI; e.g. urn:uuid:c757873d-ec9a-4326-a141-556f43239520

health.fhir.r4: xhtml

xhtml

Description

health.fhir.r4: urlType

urlType

Description

Integer types

health.fhir.r4: integer

integer

A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal)

Regex: [0]|[-+]?[1-9][0-9]*

health.fhir.r4: positiveInt

positiveInt

Any positive integer in the range 1..2,147,483,647

Regex:+?[1-9][0-9]*

health.fhir.r4: unsignedInt

unsignedInt

Any non-negative integer in the range 0..2,147,483,647

Regex: [0]|([1-9][0-9]*)

health.fhir.r4: integer64