Module health.fhir.r5
ballerinax/health.fhir.r5 Ballerina library
0.9.0
FHIR R5 Base module
Sample Usage
This section focuses on samples depicting how to use this package to implement FHIR related integrations
Prerequisites
- Install Ballerina 2201.10.3 or later
Parsing FHIR Resource payloads and access the parsed data
Sample below is using the Patient resource in health.fhir.r5.internationa500 package.
import ballerina/io; import ballerinax/health.fhir.r5 as fhir; import ballerinax/health.fhir.r5.international500; import ballerinax/health.fhir.r5.parser as fhirParser; public function main() returns error? { // The following example is a simple serialized Patient resource to parse json input = { "resourceType": "Patient", "name": [ { "family": "Simpson" } ] }; // Parse it - you can pass the input (as a string or a json) and the // type of the resource you want to parse. international500:Patient patient = check fhirParser:parse(input).ensureType(); // Access the parsed data fhir:HumanName[]? names = patient.name; if names is () || names.length() == 0 { return error("Failed to parse the names"); } io:println("Family Name: ", names[0]); }
Functions
annotationDataTypeValidationFunction
Isolated Function
function annotationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns FHIRValidationError?This function validates the data type definition of Annotation.
Parameters
- data anydata - Data to be validated
- elementContextDefinition ElementAnnotationDefinition - Element definition of the data
Return Type
- FHIRValidationError? - FHIRValidationError array if data is not valid or else nil
clientErrorToFhirError
Isolated Function
function clientErrorToFhirError(ClientError clientError) returns FHIRErrorConvert a http client error to a FHIR error.
Parameters
- clientError ClientError - http:ClientError.
Return Type
- FHIRError - Return a FHIR error.
complexDataTypeJsonSerializer
Isolated Function
function complexDataTypeJsonSerializer(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRWireFormat|FHIRSerializerError)?Serializes a complex data type to a JSON representation
Parameters
- data anydata - data to be serialized
- elementContextDefinition ElementAnnotationDefinition - element definition of the data
Return Type
- (FHIRWireFormat|FHIRSerializerError)? - JSON representation of the data
complexDataTypeXMLSerializer
Isolated Function
function complexDataTypeXMLSerializer(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRWireFormat|FHIRSerializerError)?Serializes a complex data type to a XML representation
Parameters
- data anydata - data to be serialized
- elementContextDefinition ElementAnnotationDefinition - element definition of the data
Return Type
- (FHIRWireFormat|FHIRSerializerError)? - XML representation of the data
createAbsoluteFhirReference
Isolated Function
function createAbsoluteFhirReference(typedesc<anydata> referenceResourceModel, string absolutePathToReference) returns Reference|FHIRErrorCreate an absolute Reference to FHIR Resource.
Parameters
- referenceResourceModel typedesc<anydata> - FHIR Resource model of the Reference
- absolutePathToReference string - Absolute path to Reference
createContainedFhirReference
Isolated Function
function createContainedFhirReference(map<anydata> targetResource, Resource resourceTypeReference) returns Reference|FHIRErrorCreate a contained Reference to FHIR Resource.
createFhirBundle
Isolated Function
function createFhirBundle(BundleType t, DomainResource[] resources) returns BundleCreate a FHIR Bundle.
Return Type
- Bundle - Return a FHIR Bundle.
createFHIRError
Isolated Function
function createFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, FHIRErrorTypes? errorType, int httpStatusCode) returns FHIRErrorUtility function to create FHIRError.
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
- 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
createInternalFHIRError
Isolated Function
function createInternalFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, FHIRErrorTypes? errorType) returns FHIRErrorUtility function to create internal FHIRError.
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
Return Type
- FHIRError - Created FHIRError error
createParserErrorFrom
Isolated Function
function createParserErrorFrom(FHIRError fhirError) returns FHIRParseErrorError util function to create FHIR Parser Error from any given FHIR Error.
Parameters
- fhirError FHIRError - Source FHIR Error
Return Type
- FHIRParseError - Created FHIR Parser Error
createRelativeFhirReference
Isolated Function
function createRelativeFhirReference(typedesc<anydata> referenceResourceModel, string relativePathToReference) returns Reference|FHIRErrorCreate a relative Reference to FHIR Resource.
Parameters
- referenceResourceModel typedesc<anydata> - FHIR Resource model of the Reference
- relativePathToReference string - Relative path to Reference
createRequestSearchParameter
Isolated Function
function createRequestSearchParameter(FHIRSearchParameterDefinition|CommonSearchParameterDefinition|FHIROperationParameterDefinition definition, FHIRSearchParameterModifier|string? modifier, anydata value) returns RequestSearchParameter|FHIRErrordataFilterDataTypeValidationFunction
Isolated Function
function dataFilterDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the data type definition of the ElementDateFilter record.
Parameters
- data anydata - data to be validated
- elementContextDefinition ElementAnnotationDefinition - element context definition
Return Type
- (FHIRValidationError)? - FHIRValidationError array or else nil
dataRequirementDataTypeValidationFunction
Isolated Function
function dataRequirementDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the data type of the DataRequirement element
Parameters
- data anydata - Data to be validated
- elementContextDefinition ElementAnnotationDefinition - Element context definition
Return Type
- (FHIRValidationError)? - FHIRValidationError array if validation fails or else nil
decodeFhirSearchParameters
Isolated Function
function decodeFhirSearchParameters(string urlEncodedParams) returns map<RequestSearchParameter[] & readonly>|FHIRErrorParameters
- urlEncodedParams string -
decodeSearchParameterKey
Isolated Function
function decodeSearchParameterKey(string paramName, string[] values) returns RequestQueryParameter|FHIRErrordosageDataTypeValidationFunction
Isolated Function
function dosageDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the dosage data type
Parameters
- data anydata - data to be validated
- elementContextDefinition ElementAnnotationDefinition - Element context definition
Return Type
- (FHIRValidationError)? - FHIRValidationError array if validation fails, else nil
doseAndRateDataTypeValidationFunction
Isolated Function
function doseAndRateDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the data type of the DoseAndRate element
Parameters
- data anydata - Data to be validated
- elementContextDefinition ElementAnnotationDefinition - Element context definition
Return Type
- (FHIRValidationError)? - FHIRValidationError array if validation fails
elementDefinitionDataTypeValidationFunction
Isolated Function
function elementDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the data type of the element definition record.
Parameters
- data anydata - data to be validated
- elementContextDefinition ElementAnnotationDefinition - element definition record
Return Type
- (FHIRValidationError)? - error if validation fails
errorToOperationOutcome
Isolated Function
function errorToOperationOutcome(FHIRError fhirError) returns OperationOutcomeUtility function to create OperationOutcome from FHIRError.
Parameters
- fhirError FHIRError - FHIRError to be converted
Return Type
- OperationOutcome - created OperationOutcome record
executeResourceJsonSerializer
Isolated Function
function executeResourceJsonSerializer(anydata fhirResource) returns (json|FHIRSerializerError)Serializes a FHIR Resource to a JSON representation
Parameters
- fhirResource anydata - FHIR Resource to be serialized
Return Type
- (json|FHIRSerializerError) - JSON representation of the data
executeResourceXMLSerializer
Isolated Function
function executeResourceXMLSerializer(anydata fhirResource) returns (xml|FHIRSerializerError)Serializes a FHIR Resource to a XML representation
Parameters
- fhirResource anydata - FHIR Resource to be serialized
Return Type
- (xml|FHIRSerializerError) - XML representation of the data
extractActiveSearchParameterNames
Isolated Function
function extractActiveSearchParameterNames(map<SearchParamConfig> paramConfig) returns string[]Parameters
- paramConfig map<SearchParamConfig> -
fhirBundleJsonSerializer
Isolated Function
function fhirBundleJsonSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?Parameters
- data Bundle -
fhirBundleXmlSerializer
Isolated Function
function fhirBundleXmlSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?Parameters
- data Bundle -
fhirResourceJsonSerializer
Isolated Function
function fhirResourceJsonSerializer(anydata data) returns (FHIRWireFormat|FHIRSerializerError)?Serializes a FHIR Resource to a JSON representation
Parameters
- data anydata - data to be serialized
Return Type
- (FHIRWireFormat|FHIRSerializerError)? - JSON representation of the data
fhirResourceXMLSerializer
Isolated Function
function fhirResourceXMLSerializer(anydata data) returns (FHIRWireFormat|FHIRSerializerError)?Serializes a FHIR Resource to a XML representation
Parameters
- data anydata - data to be serialized
Return Type
- (FHIRWireFormat|FHIRSerializerError)? - XML representation of the data
getErrorCode
Isolated Function
Parameters
- errorResponse error -
getErrorMessage
Isolated Function
function getErrorMessage(ClientRequestError requestError) returns stringExtract error messages from 4xx errors.
Parameters
- requestError ClientRequestError - ClientRequestError.
Return Type
- string - Error message.
getFHIRContext
Isolated Function
function getFHIRContext(RequestContext httpCtx) returns FHIRContext|FHIRErrorGet the FHIR context from the HTTP request context.
Parameters
- httpCtx RequestContext - HTTP request context
Return Type
- FHIRContext|FHIRError - FHIR context or error
getRequestResourceEntity
Isolated Function
function getRequestResourceEntity(RequestContext ctx) returns FHIRResourceEntity|FHIRErrorGet request resource entity from the FHIR context.
Parameters
- ctx RequestContext - HTTP request context
Return Type
- FHIRResourceEntity|FHIRError - FHIR resource entity or error
getResourceDefinition
Isolated Function
function getResourceDefinition(typedesc resourceType) returns ResourceDefinitionRecord|FHIRTypeErrorParameters
- resourceType typedesc -
handleAuditEvent
Isolated Function
function handleAuditEvent(Client auditClient, FHIRContext fhirContext) returns AuditEventSendingError?Call audit service and handle response.
Parameters
- auditClient Client - @http:Client to call audit service
- fhirContext FHIRContext - context of the request
Return Type
- AuditEventSendingError? - FHIRError if audit service call fails
handleErrorResponse
Isolated Function
function handleErrorResponse(error errorResponse) returns OperationOutcomeParameters
- errorResponse error -
handleSmartSecurity
Isolated Function
function handleSmartSecurity(AuthzConfig authzConfig, FHIRSecurity fhirSecurity, string? patientId) returns FHIRError?Call authz service and handle response.
Parameters
- authzConfig AuthzConfig - Authorization service configuration
- fhirSecurity FHIRSecurity - FHIRSecurity record containg backend JWT
- patientId string? (default ()) - Requested patient ID
Return Type
- FHIRError? - returns FHIRError if authz service call fails or user is not authorized
populationDataTypeValidationFunction
Isolated Function
function populationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?primitiveTypeToSearchParamType
Isolated Function
function primitiveTypeToSearchParamType(string primitiveType) returns FHIRSearchParameterType|FHIRErrorMaps a given FHIR primitive type to a corresponding FHIR search parameter type.
Parameters
- primitiveType string - The FHIR primitive type to be mapped
Return Type
- FHIRSearchParameterType|FHIRError - The corresponding FHIR search parameter type or a
FHIRErrorif the primitive type does not correspond to a search parameter type
rangeDataTypeValidationFunction
Isolated Function
function rangeDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?ratioDataTypeValidationFunction
Isolated Function
function ratioDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?repeatElementDataTypeValidationFunction
Isolated Function
function repeatElementDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?This function validates the data type of the element
Parameters
- data anydata - data to be validated
- elementContextDefinition ElementAnnotationDefinition - Element context definition
Return Type
- (FHIRValidationError)? - FHIRValidationError array if validation fails, else nil
substanceAmountDataTypeValidationFunction
Isolated Function
function substanceAmountDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?triggerDefinitionDataTypeValidationFunction
Isolated Function
function triggerDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?urlEncodeFhirSearchParameters
Isolated Function
function urlEncodeFhirSearchParameters(map<RequestSearchParameter[] & readonly> & readonly params) returns string|FHIRErrorParameters
- params map<RequestSearchParameter[] & readonly> & readonly -
usageContextDataTypeValidationFunction
Isolated Function
function usageContextDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?Classes
health.fhir.r5: FHIRContainerResourceEntity
Isolated
Class to wrap FHIR resource
unwrap
Isolated Function
function unwrap() returns anydatatoXml
Isolated Function
function toXml() returns xml|FHIRSerializerErrortoJson
Isolated Function
function toJson() returns json|FHIRSerializerErrorhealth.fhir.r5: FHIRContainerResponse
Isolated
Class representing FHIR Container response (Bundle)
getResourceEntity
Isolated Function
function getResourceEntity() returns FHIRContainerResourceEntityhealth.fhir.r5: FHIRContext
Isolated
FHIR Context class: used to transfer FHIR request related information down integration flow
setDirection
Isolated Function
function setDirection(MessageDirection direction)Set context direction : indicate whether the request is in request direction or response direction.
Parameters
- direction MessageDirection - message direction (IMPORTANT : This is used for internal processing hence adviced not to update)
getDirection
Isolated Function
function getDirection() returns MessageDirectionGet context direction : indicate whether the request is in request direction or response direction.
Return Type
- MessageDirection - Message direction
setRawPath
Isolated Function
function setRawPath(string path)Set the raw path of the requested resource.
Parameters
- path string - raw path of the requested resource.
getRawPath
Isolated Function
function getRawPath() returns stringGets the raw path of the requested resource.
Return Type
- string - return the raw path of the requested resource.
isInErrorState
Isolated Function
function isInErrorState() returns booleanSet error state : indicate whether the request is in error state or not.
Return Type
- boolean - whether the request is in error state or not.
setInErrorState
Isolated Function
function setInErrorState(boolean inErrorState)Set error state : indicate whether the request is in error state or not.
Parameters
- inErrorState boolean - whether the request is in error state or not.
setErrorCode
Isolated Function
function setErrorCode(int errorCode)Get error code : error code of the request, if in error.
Parameters
- errorCode int - error code of the request, if in error.
getErrorCode
Isolated Function
function getErrorCode() returns intGet error code : error code of the request, if in error.
Return Type
- int - error code of the request, if in error.
getFHIRRequest
Isolated Function
function getFHIRRequest() returns FHIRRequest?Get FHIR request. FHIR request parsed information about incoming FHIR request from the client application.
Return Type
- FHIRRequest? - FHIR request object
getFHIRSecurity
Isolated Function
function getFHIRSecurity() returns FHIRSecurity?Get FHIR security information. FHIR request derived security information about incoming FHIR request from the client application.
Return Type
- FHIRSecurity? - FHIR security record
getHTTPRequest
Isolated Function
function getHTTPRequest() returns HTTPRequest?Get incoming raw HTTP request information.
Return Type
- HTTPRequest? - Incoming HTTP request
getFHIRResponse
Isolated Function
function getFHIRResponse() returns FHIRResponse|FHIRContainerResponse?Get FHIR response.
Return Type
- FHIRResponse|FHIRContainerResponse? - FHIR response
getProperty
Isolated Function
function getProperty(string key) returns anydata?Get a property from the fhir context.
Parameters
- key string - property key
Return Type
- anydata? - property value
setProperty
Isolated Function
function setProperty(string key, anydata value)Set a property to the fhir context.
setPaginationContext
Isolated Function
function setPaginationContext(PaginationContext paginationContext)Set pagination info to fhir context.
Parameters
- paginationContext PaginationContext - Pagination context record with page size and page number
getPaginationContext
Isolated Function
function getPaginationContext() returns PaginationContext?Get pagination info from fhir context.
Return Type
- PaginationContext? - Pagination context
getInteraction
Isolated Function
function getInteraction() returns FHIRInteractionGet FHIR interaction information parsed from the incoming FHIR request. http://hl7.org/fhir/http.html#3.1.0.
Return Type
- FHIRInteraction - FHIR interaction record
getResourceType
Isolated Function
function getResourceType() returns string?Get target FHIR resource type.
Return Type
- string? - FHIR resource type
getClientAcceptFormat
Isolated Function
function getClientAcceptFormat() returns FHIRPayloadFormatGet client accepted response format.
Return Type
- FHIRPayloadFormat - Client accepted FHIR payload format
getFHIRUser
Isolated Function
function getFHIRUser() returns readonly & FHIRUser?Get FHIR User : End user information available in the JWT.
Return Type
- readonly & FHIRUser? - FHIR Usr information
getRequestSearchParameters
Isolated Function
function getRequestSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>Get all request parameters.
Return Type
- readonly & map<readonly & RequestSearchParameter[]> - Request search parameter map (Key of the map is name of the search parameter).
getRequestSearchParameter
Isolated Function
function getRequestSearchParameter(string name) returns readonly & RequestSearchParameter[]?Get search parameter with given name.
Parameters
- name string - Name of the search parameter
Return Type
- readonly & RequestSearchParameter[]? - Request search parameter array if available. Otherwise nil
getNumberSearchParameter
Isolated Function
function getNumberSearchParameter(string name) returns NumberSearchParameter[]|FHIRTypeError?Function to get Number typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- NumberSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Number type
getReferenceSearchParameter
Isolated Function
function getReferenceSearchParameter(string name) returns ReferenceSearchParameter[]|FHIRTypeError?Function to get Reference typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- ReferenceSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Reference type
getStringSearchParameter
Isolated Function
function getStringSearchParameter(string name) returns StringSearchParameter[]|FHIRTypeError?Function to get String typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- StringSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not String type
getTokenSearchParameter
Isolated Function
function getTokenSearchParameter(string name) returns TokenSearchParameter[]|FHIRTypeError?Function to get Token typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- TokenSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Token type
getURISearchParameter
Isolated Function
function getURISearchParameter(string name) returns URISearchParameter[]|FHIRTypeError?Function to get URI typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- URISearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not URI type
getDateSearchParameter
Isolated Function
function getDateSearchParameter(string name) returns DateSearchParameter[]|FHIRTypeError?Function to get Date typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- DateSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Date type
getQuantitySearchParameter
Isolated Function
function getQuantitySearchParameter(string name) returns QuantitySearchParameter[]|FHIRTypeError?Function to get Quantity typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- QuantitySearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Quantity type
getCompositeSearchParameter
Isolated Function
function getCompositeSearchParameter(string name) returns CompositeSearchParameter[]|FHIRTypeError?Function to get Composite typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- CompositeSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Composite type
getSpecialSearchParameter
Isolated Function
function getSpecialSearchParameter(string name) returns SpecialSearchParameter[]|FHIRTypeError?Function to get Special typed search parameter with given name from the FHIR API request.
Parameters
- name string - Name of the search parameter
Return Type
- SpecialSearchParameter[]|FHIRTypeError? - Search parameter if exists, nill if not found and FHIRTypeError if search parameter is not Special type
health.fhir.r5: FHIRImplementationGuide
Isolated
Represents FHIR Implementation Guide holding information and functionalities bound to it
getName
Isolated Function
function getName() returns stringgetTerminology
Isolated Function
function getTerminology() returns TerminologygetProfiles
Isolated Function
getSearchParameters
Isolated Function
function getSearchParameters() returns map<FHIRSearchParameterDefinition[]>[]getOperations
Isolated Function
function getOperations() returns map<FHIROperationDefinition[]>?Get IG FHIR operation definitions.
Return Type
- map<FHIROperationDefinition[]>? - A map of FHIR operation definitions
health.fhir.r5: FHIRRegistry
Isolated
Hold FHIR related information in a particular deployment
addImplementationGuide
function addImplementationGuide(FHIRImplementationGuide ig) returns FHIRError?Add an implementation guide to the registry
Parameters
- ig FHIRImplementationGuide - The implementation guide to be added
Return Type
- FHIRError? - An error if the implementation guide is invalid or an error occurred while adding the implementation guide
getResourceProfiles
Isolated Function
Get the resource profiles in the registry
Parameters
- resourceType string - The resource type
getResourceSearchParameters
Isolated Function
function getResourceSearchParameters(string resourceType) returns SearchParamCollectionGet the resource search parameters in the registry
Parameters
- resourceType string - The resource type
Return Type
- SearchParamCollection - The search parameters in the registry
getResourceSearchParameterByName
Isolated Function
function getResourceSearchParameterByName(string resourceType, string name) returns FHIRSearchParameterDefinition?Get the search parameters in the registry by name
Return Type
- FHIRSearchParameterDefinition? - The search parameters in the registry
getResourceOperations
Isolated Function
function getResourceOperations(string resourceType) returns OperationCollectionGet the resource operations in the registry.
Parameters
- resourceType string - The resource type
Return Type
- OperationCollection - The operations in the registry
getResourceOperationByName
Isolated Function
function getResourceOperationByName(string resourceType, string operation) returns FHIROperationDefinition?Get a resource operation in the registry by name.
Return Type
- FHIROperationDefinition? - The operation if found in the registry, otherwise ()
findProfile
Isolated Function
Get the profiles in the registry
Parameters
- url string - The url of the profile
Return Type
- (readonly & Profile)? - The profiles in the registry
findBaseProfile
Isolated Function
Get the base profiles in the registry
Parameters
- resourceType string - The resource type
Return Type
- (readonly & Profile)? - The base profile in the registry
isSupportedResource
Isolated Function
Check the resource type is supported by the registry
Parameters
- resourceType string - The resource type
Return Type
- boolean - True if the resource type is supported
addSearchParameter
Isolated Function
function addSearchParameter(string resourceType, FHIRSearchParameterDefinition searchParameter)Add a custom search parameter to the registry
Parameters
- resourceType string - The resource type
- searchParameter FHIRSearchParameterDefinition - The search parameter to be added
health.fhir.r5: FHIRRequest
Isolated
Class representing FHIR request
getResourceEntity
Isolated Function
function getResourceEntity() returns FHIRResourceEntity?getSearchParameters
Isolated Function
function getSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>getClientAcceptFormat
Isolated Function
function getClientAcceptFormat() returns FHIRPayloadFormatgetResourceType
Isolated Function
function getResourceType() returns string?getInteraction
Isolated Function
function getInteraction() returns readonly & FHIRInteractionhealth.fhir.r5: FHIRResourceEntity
Isolated
Class to wrap FHIR resource
unwrap
Isolated Function
function unwrap() returns anydatatoXml
Isolated Function
function toXml() returns xml|FHIRSerializerErrortoJson
Isolated Function
function toJson() returns json|FHIRSerializerErrorhealth.fhir.r5: FHIRResponse
Isolated
Class representing FHIR response
getResourceEntity
Isolated Function
function getResourceEntity() returns FHIRResourceEntityhealth.fhir.r5: InMemoryTerminologyLoader
An in-memory implementation of a terminology loader
load
function load() returns Terminology|FHIRErrorload terminology
Return Type
- Terminology|FHIRError - Terminology populated
health.fhir.r5: TerminologyProcessor
A processor to process terminology data and create relevent data elements
addTerminology
function addTerminology(Terminology terminology)Parameters
- terminology Terminology -
addCodeSystems
function addCodeSystems(CodeSystem[] codeSystems)Parameters
- codeSystems CodeSystem[] -
addValueSets
function addValueSets(ValueSet[] valueSets)Parameters
- valueSets ValueSet[] -
createCodeableConcept
Isolated Function
function createCodeableConcept(uri system, code code, CodeSystemFinder? codeSystemFinder) returns CodeableConcept|FHIRErrorCreate CodeableConcept for given code in a given system.
Parameters
- system uri - system uri of the code system or value set
- code code - code interested
- codeSystemFinder CodeSystemFinder? (default ()) - (optional) custom code system function (utility will used this function to find code system in a external source system)
Return Type
- CodeableConcept|FHIRError - Created CodeableConcept record or FHIRError if not found
createCoding
Isolated Function
function createCoding(uri system, code code, CodeSystemFinder? codeSystemFinder) returns Coding|FHIRErrorCreate Coding for given code in a given system.
Parameters
- system uri - system uri of the code system or value set
- code code - code interested
- codeSystemFinder CodeSystemFinder? (default ()) - (optional) custom code system function (utility will used this function to find code system in a external source system)
Constants
health.fhir.r5: FHIR_BASE_IG
This is the FHIR base IG name
health.fhir.r5: FHIR_CONTEXT_PROP_NAME
This is the FHIR request context property name
health.fhir.r5: FHIR_MIME_TYPE_JSON
This is the FHIR MIME type FHIR+JSON
health.fhir.r5: FHIR_MIME_TYPE_XML
This is the FHIR MIME type FHIR+XML
health.fhir.r5: FHIR_NAMESPACE
This is the default FHIR XML namespace
health.fhir.r5: FHIR_SEARCH_PARAM_PROFILE
This is the FHIR common search parameter for profile
health.fhir.r5: LOCATION_HEADER_PROP_NAME
Location header property name
health.fhir.r5: PROFILE_BASE_BUNDLE
health.fhir.r5: PROFILE_BASE_CODESYSTEM
health.fhir.r5: PROFILE_BASE_OPERATIONOUTCOME
health.fhir.r5: PROFILE_BASE_VALUESET
health.fhir.r5: RESOURCE_NAME_BUNDLE
health.fhir.r5: RESOURCE_NAME_CODESYSTEM
health.fhir.r5: RESOURCE_NAME_OPERATIONOUTCOME
health.fhir.r5: RESOURCE_NAME_VALUESET
Enums
health.fhir.r5: AddressType
Members
postal
physical
both
health.fhir.r5: AddressUse
Members
home
work
temp
old
billing
health.fhir.r5: AuthzScope
FHIR Authorization scopes.
Members
PATIENT
PRACTITIONER
PRIVILEGED
health.fhir.r5: BundleType
Members
BUNDLE_TYPE_DOCUMENT
BUNDLE_TYPE_MESSAGE
BUNDLE_TYPE_TRANSACTION
BUNDLE_TYPE_TRANSACTION_RESPONSE
BUNDLE_TYPE_BATCH
BUNDLE_TYPE_BATCH_RESPONSE
BUNDLE_TYPE_HISTORY
BUNDLE_TYPE_SEARCHSET
BUNDLE_TYPE_COLLECTION
health.fhir.r5: CodeSystemContent
CodeSystemContent enum
Members
CODE_CONTENT_FRAGMENT
CODE_CONTENT_SUPPLEMENT
CODE_CONTENT_NOT_PRESENT
CODE_CONTENT_COMPLETE
CODE_CONTENT_EXAMPLE
health.fhir.r5: CodeSystemFilterOperator
CodeSystemFilterOperator enum
Members
CODE_OPERATOR_IS_NOT_A
CODE_OPERATOR_REGEX
CODE_OPERATOR_IN
CODE_OPERATOR_DESCENDENT_OF
CODE_OPERATOR_NOT_IN
CODE_OPERATOR_EXISTS
CODE_OPERATOR_GENERALIZES
CODE_OPERATOR_EQUAL
CODE_OPERATOR_IS_A
health.fhir.r5: CodeSystemHierarchyMeaning
CodeSystemHierarchyMeaning enum
Members
CODE_HIERARCHYMEANING_CLASSIFIED_WITH
CODE_HIERARCHYMEANING_PART_OF
CODE_HIERARCHYMEANING_GROUPED_BY
CODE_HIERARCHYMEANING_IS_A
health.fhir.r5: CodeSystemPropertyType
CodeSystemPropertyType enum
Members
CODE_TYPE_DATETIME
CODE_TYPE_CODE
CODE_TYPE_BOOLEAN
CODE_TYPE_STRING
CODE_TYPE_CODING
CODE_TYPE_INTEGER
CODE_TYPE_DECIMAL
health.fhir.r5: CodeSystemStatus
CodeSystemStatus enum
Members
CODE_STATUS_DRAFT
CODE_STATUS_ACTIVE
CODE_STATUS_RETIRED
CODE_STATUS_UNKNOWN
health.fhir.r5: ContactPointSystem
Members
phone
fax
email
pager
url
sms
other
health.fhir.r5: ContactPointUse
Members
home
work
temp
old
mobile
health.fhir.r5: ContributerType
Members
author
editor
reviewer
endorser
health.fhir.r5: ContributorType
Members
author
editor
reviewer
endorser
health.fhir.r5: Daycode
Members
mon
tue
wed
thu
fri
sat
sun
health.fhir.r5: DirectionCode
Members
'ascending
'descending
health.fhir.r5: ElementDiscriminatorType
Members
value
exists
pattern
'type
profile
health.fhir.r5: ElementSlicingRules
Members
closed
open
openAtEnd
health.fhir.r5: FHIRErrorTypes
FHIR Error types
Members
VALIDATION_ERROR
PROCESSING_ERROR
SERIALIZATION_ERROR
PARSE_ERROR
TYPE_ERROR
health.fhir.r5: FHIRInteractionLevel
FHIR Interaction levels
Members
FHIR_INTERACTION_INSTANCE
FHIR_INTERACTION_TYPE
FHIR_INTERACTION_SYSTEM
health.fhir.r5: FHIRInteractionType
FHIR REST Interactions
Members
READ
VREAD
UPDATE
PATCH
DELETE
HISTORY
CREATE
SEARCH
CAPABILITIES
BATCH
TRANSACTION
OPERATION
health.fhir.r5: FHIRPayloadFormat
FHIR Payload formats
Members
JSON
XML
health.fhir.r5: FHIRSearchParameterModifier
FHIR search parameter modifiers
Members
MODIFIER_ABOVE
MODIFIER_BELOW
MODIFIER_CODE_TEXT
MODIFIER_CONTAINS
MODIFIER_EXACT
MODIFIER_IDENTIFIER
MODIFIER_IN
MODIFIER_ITERATE
MODIFIER_MISSING
MODIFIER_NOT
MODIFIER_NOT_IN
MODIFIER_OF_TYPE
MODIFIER_TEXT
MODIFIER_TEXT_ADVANCED
health.fhir.r5: FHIRSearchParameterType
FHIR search parameter types
Members
NUMBER
DATE
STRING
TOKEN
REFERENCE
COMPOSITE
QUANTITY
URI
SPECIAL
health.fhir.r5: HTTPVerb
Members
GET
HEAD
POST
PUT
DELETE
PATCH
health.fhir.r5: HumanNameUse
Members
usual
official
temp
nickname
anonymous
old
maiden
health.fhir.r5: IdentifierUse
Members
usual
official
temp
secondary
old
health.fhir.r5: IssueType
Code that describes the type of issue.
Members
INVALID
INVALID_STRUCTURE
INVALID_REQUIRED
INVALID_VALUE
INVALID_INVARIANT
SECURITY
SECURITY_LOGIN
SECURITY_UNKNOWN
SECURITY_EXPIRED
SECURITY_FORBIDDEN
SECURITY_SUPPRESSED
PROCESSING
PROCESSING_NOT_SUPPORTED
PROCESSING_DUPLICATE
PROCESSING_MULTIPLE_MATCHES
PROCESSING_NOT_FOUND
PROCESSING_NOT_FOUND_DELETED
PROCESSING_TOO_LONG
PROCESSING_CODE_INVALID
PROCESSING_EXTENSION
PROCESSING_TOO_COSTLY
PROCESSING_BUSINESS_RULE
PROCESSING_CONFLICT
TRANSIENT
TRANSIENT_LOCK_ERROR
TRANSIENT_NO_STORE
TRANSIENT_EXCEPTION
TRANSIENT_TIMEOUT
TRANSIENT_INCOMPLETE
TRANSIENT_THROTTLED
INFORMATIONAL
health.fhir.r5: MessageDirection
Enum to indicate message flow direction
Members
IN
OUT
health.fhir.r5: MonetaryComponentType
Members
CODE_MONETARYCOMPONENTTYPE_SURCHARGE
CODE_MONETARYCOMPONENTTYPE_DEDUCTION
CODE_MONETARYCOMPONENTTYPE_DISCOUNT
CODE_MONETARYCOMPONENTTYPE_TAX
CODE_MONETARYCOMPONENTTYPE_INFORMATIONAL
CODE_MONETARYCOMPONENTTYPE_BASE
health.fhir.r5: OperationOutcomeIssueSeverity
OperationOutcomeIssueSeverity enum
Members
CODE_SEVERITY_WARNING
CODE_SEVERITY_INFORMATION
CODE_SEVERITY_ERROR
CODE_SEVERITY_FATAL
health.fhir.r5: OperationParameterUse
Usage of parameters in an operation.
Members
INPUT
OUTPUT
health.fhir.r5: ParameterDefinitionUse
Members
'in
out
health.fhir.r5: Prefix
For the ordered parameter types of number, date, and quantity, a prefix to the parameter value may be used to control the nature of the matching
Members
eq
ne
gt
lt
ge
le
sa
eb
ap
health.fhir.r5: QuantityComparatorCode
Members
LESS_THAN
LESS_THAN_EQUAL
GREATER_THAN_EQUAL
GREATER_THAN
health.fhir.r5: RepeatCode
Members
BID
TID
QID
AM
PM
QD
QOD
Q1H
Q2H
Q3H
Q4H
Q6H
Q8H
BED
WK
MO
health.fhir.r5: SearchEntryMode
Members
MATCH
INCLUDE
OUTCOME
health.fhir.r5: SearchParameterEffectiveLevel
Members
SEARCH_PARAM_CATEGORY_RESOURCE_BOUND
SEARCH_PARAM_CATEGORY_RESOURCE_COMMON
SEARCH_PARAM_CATEGORY_SEARCH_RESULT
SEARCH_PARAM_CATEGORY_SPECIAL
health.fhir.r5: Severity
Level the issue affects the success of the action.
Members
FATAL
ERROR
WARNING
INFORMATION
health.fhir.r5: StatusCode
Members
generated
extensions
additional
empty
health.fhir.r5: StrengthCode
Members
required
extensible
preferred
example
health.fhir.r5: Timecode
Members
s
min
h
d
wk
mo
a
health.fhir.r5: TypeAggregation
Members
contained
referenced
bundled
health.fhir.r5: TypeVersioning
Members
either
independent
specific
health.fhir.r5: ValueSetComposeIncludeFilterOp
ValueSetComposeIncludeFilterOp enum
Members
CODE_OP_IS_NOT_A
CODE_OP_REGEX
CODE_OP_IN
CODE_OP_DESCENDENT_OF
CODE_OP_NOT_IN
CODE_OP_EXISTS
CODE_OP_GENERALIZES
CODE_OP_EQUAL
CODE_OP_IS_A
health.fhir.r5: ValueSetStatus
ValueSetStatus enum
Members
CODE_STATUS_DRAFT
CODE_STATUS_ACTIVE
CODE_STATUS_RETIRED
CODE_STATUS_UNKNOWN
Variables
health.fhir.r5: terminologyProcessor
Terminology processor instance
health.fhir.r5: fhirRegistry
FHIR registry instance
health.fhir.r5: COMMON_SEARCH_PARAMETERS
Search Parameters for all resources
health.fhir.r5: CONTROL_SEARCH_PARAMETERS
Search Parameter to control search results
health.fhir.r5: BASE_RESOURCE_OPERATIONS
Base operations for all resources.
health.fhir.r5: FHIR_VALUE_SETS
health.fhir.r5: FHIR_CODE_SYSTEMS
Annotations
health.fhir.r5: ContainerDefinition
typehealth.fhir.r5: DataTypeDefinition
typehealth.fhir.r5: ResourceDefinition
typeRecords
health.fhir.r5: Address
Closed record
An address expressed using postal conventions
Fields
- Fields Included from *Element
- id? string - id for the element
- extension? Extension[] - Extensions for the element
- use? AddressUse - [home | work | temp | old | billing] - purpose of this address AddressUse (Required) (http://hl7.org/fhir/valueset-address-use.html)
- 'type? AddressType - [postal | physical | both] AddressType (Required) (http://hl7.org/fhir/valueset-address-type.html)
- text? string - Text representation of the address
- line? string[] - Street name, number, direction & P.O. Box etc.
- city? string - Name of city, town etc.
- district? string - District name (aka county)
- state? string - Sub-unit of country (abbreviations ok)
- postalCode? string - Postal code for area
- country? string - Country (e.g. can be ISO 3166 2 or 3 letter code)
- period? Period - Time period when address was/is in use
health.fhir.r5: AddressExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueAddress Address -
health.fhir.r5: Age
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- ageValue? integer -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: AgeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueAge Age -
health.fhir.r5: Annotation
Closed record
Text node with attribution Elements defined in Ancestors: id, extension
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- time? dateTime - When the annotation was made
- text markdown - The annotation - text content (as markdown)
health.fhir.r5: AnnotationExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueAnnotation Annotation -
health.fhir.r5: ApiInfo
Closed record
FHIR API information.
Fields
- resourceTypereadonly string - FHIR resource type
- searchParametersreadonly string[] - supported search parameters
health.fhir.r5: Attachment
Closed record
Content in a format defined elsewhere. Rule: If the Attachment has data, it SHALL have a contentType.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- contentType? code - Mime type of the content, with charset etc. MimeType (Required) (http://hl7.org/fhir/valueset-mimetypes.html)
- language? code - Human language of the content (BCP-47) Common Languages (Preferred but limited to AllLanguages) (http://hl7.org/fhir/valueset-languages.html)
- data? base64Binary - Data inline, base64ed
- url? urlType - Uri where the data can be found
- size? unsignedInt - Number of bytes of content (if url provided)
- hash? base64Binary - Hash of the data (sha-1, base64ed)
- title? string - Label to display in place of the data
- creation? dateTime - Date attachment was first created
health.fhir.r5: AttachmentExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueAttachment Attachment -
health.fhir.r5: AuditConfig
Closed record
Audit service integration related configuration.
Fields
- enabled boolean(default false) - enable or disable integration with audit service
- auditServiceUrl string - url of the audit service
health.fhir.r5: AuditEventSendingError
Closed record
On an error sending an audit event, this record will be used.
Fields
- fhirError? FHIRError - error occurred while sending audit event
- auditEvent InternalAuditEvent - audit event that failed to send
health.fhir.r5: AuthzConfig
Closed record
FHIR Authorization service configuration record.
Fields
- authzServiceUrl string - Authorization service URL
- privilegedClaimUrl string? - Claim that has privilege to access all patients
health.fhir.r5: AuthzRequest
Closed record
FHIR Authorization request record.
Fields
- fhirSecurity FHIRSecurity - FHIRSecurity record containg backend JWT
- patientId? string - Authorized patient ID
- privilegedClaimUrl? string - Claim that has privilege to access all patients
health.fhir.r5: AuthzResponse
Closed record
FHIR Authorization response record.
Fields
- isAuthorized boolean - Whether the user is authorized to view requested patient data
- scope? AuthzScope - Granted scope
health.fhir.r5: Availability
Closed record
Fields
- availableTime? AvailableTime[] -
- notAvailableTime? NotAvailableTime[] -
health.fhir.r5: AvailabilityExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueAvailability Availability -
health.fhir.r5: AvailableTime
Closed record
Fields
- Fields Included from *Element
- id? string -
- extension? Extension[] -
- daysOfWeek? string -
- allDay? string -
- availableStartTime? string -
- availableEndTime? string -
health.fhir.r5: BackboneElement
Closed record
Base for elements defined inside a resource Elements defined in Ancestors: id, extension.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
health.fhir.r5: BackboneType
Closed record
Base for elements defined inside a resource Elements defined in Ancestors: id, extension.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
health.fhir.r5: Base64BinaryExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueBase64Binary base64Binary -
health.fhir.r5: BaseBundleMeta
Closed record
Fields
- Fields Included from *Meta
- id? string -
- extension? Extension[] -
- versionId? id -
- lastUpdated? instant -
- 'source? uri -
- profile canonical[](default [PROFILE_BASE_BUNDLE]) -
- security? Coding[] -
- tag? Coding[] -
health.fhir.r5: BaseCodeSystemMeta
Closed record
Fields
- Fields Included from *Meta
- id? string -
- extension? Extension[] -
- versionId? id -
- lastUpdated? instant -
- 'source? uri -
- profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]) -
- security? Coding[] -
- tag? Coding[] -
health.fhir.r5: BaseOperationOutcomeMeta
Closed record
Fields
- Fields Included from *Meta
- id? string -
- extension? Extension[] -
- versionId? id -
- lastUpdated? instant -
- 'source? uri -
- profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]) -
- security? Coding[] -
- tag? Coding[] -
health.fhir.r5: BaseValueSetMeta
Closed record
Fields
- Fields Included from *Meta
- id? string -
- extension? Extension[] -
- versionId? id -
- lastUpdated? instant -
- 'source? uri -
- profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ValueSet"]) -
- security? Coding[] -
- tag? Coding[] -
health.fhir.r5: BooleanExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueBoolean boolean -
health.fhir.r5: Bundle
Closed record
Fields
- Fields Included from *Resource
- resourceType RESOURCE_NAME_BUNDLE(default RESOURCE_NAME_BUNDLE) -
- id? string -
- meta BaseBundleMeta(default { profile : [PROFILE_BASE_BUNDLE] }) -
- implicitRules? uri -
- language? code -
- identifier? Identifier -
- 'type BundleType -
- timestamp? instant -
- total? unsignedInt -
- link? BundleLink[] -
- entry? BundleEntry[] -
- signature? Signature -
health.fhir.r5: BundleEntry
Closed record
Fields
- link? BundleLink[] -
- fullUrl? uri -
- 'resource? anydata|FHIRWireFormat -
- search? BundleEntrySearch -
- request? BundleEntryRequest -
- response? BundleEntryResponse -
health.fhir.r5: BundleEntryModel
Closed record
Fields
- link? BundleLink[] -
- fullUrl? uri -
- 'resource? AnyBaseResource|FHIRWireFormat -
- search? BundleEntrySearch -
- request? BundleEntryRequest -
- response? BundleEntryResponseModel -
health.fhir.r5: BundleEntryRequest
Closed record
Fields
- method HTTPVerb -
- url uri -
- ifNoneMatch? string -
- ifModifiedSince? instant -
- ifMatch? string -
- ifNoneExist? string -
health.fhir.r5: BundleEntryResponse
Closed record
Fields
- status string -
- location? uri -
- etag? string -
- lastModified? instant -
- outcome? anydata|FHIRWireFormat -
health.fhir.r5: BundleEntryResponseModel
Closed record
Fields
- status string -
- location? uri -
- etag? string -
- lastModified? instant -
- outcome? AnyBaseResource|FHIRWireFormat -
health.fhir.r5: BundleEntrySearch
Closed record
Fields
- mode? SearchEntryMode -
- score? decimal -
health.fhir.r5: BundleLink
Closed record
Fields
- relation string -
- url uri -
health.fhir.r5: BundleWireModel
Closed record
Fields
- Fields Included from *Resource
- resourceType RESOURCE_NAME_BUNDLE(default RESOURCE_NAME_BUNDLE) -
- id? string -
- meta BaseBundleMeta(default { profile : [PROFILE_BASE_BUNDLE] }) -
- implicitRules? uri -
- language? code -
- identifier? Identifier -
- 'type BundleType -
- timestamp? instant -
- total? unsignedInt -
- link? BundleLink[] -
- entry? BundleEntryModel[] -
- signature? Signature -
health.fhir.r5: CanonicalExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCanonical canonical -
health.fhir.r5: CodeableConcept
Closed record
A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies but may also be defined by the provision of text.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- coding? Coding[] - Code defined by a terminology system
- text? string - Plain text representation of the concept
health.fhir.r5: CodeableConceptExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCodeableConcept CodeableConcept -
health.fhir.r5: CodeableReference
Closed record
Reference to a resource or a concept.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- concept? CodeableConcept - Reference to a concept (by class)
- reference? Reference - Reference to a resource (by instance)
health.fhir.r5: CodeableReferenceExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCodeableReference CodeableReference -
health.fhir.r5: CodeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCode code -
health.fhir.r5: CodeSystem
FHIR CodeSystem resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_CODESYSTEM(default RESOURCE_NAME_CODESYSTEM) - The type of the resource describes
- meta BaseCodeSystemMeta(default { profile : [PROFILE_BASE_CODESYSTEM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- date? dateTime - The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
- copyright? markdown - A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueSet? canonical - Canonical reference to the value set that contains the entire code system.
- purpose? markdown - Explanation of why this code system is needed and why it has been designed as it has.
- concept? CodeSystemConcept[] - Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
- jurisdiction? CodeableConcept[] - A legal or geographic region in which the code system is intended to be used.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description? markdown - A free text natural language description of the code system from a consumer's perspective.
- experimental? boolean - A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language? code - The base language in which the resource is written.
- title? string - A short, descriptive, user-friendly title for the code system.
- content CodeSystemContent - The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
- hierarchyMeaning? CodeSystemHierarchyMeaning - The meaning of the hierarchy of concepts as represented in this resource.
- contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.
- property? CodeSystemProperty[] - A property defines an additional slot through which additional information can be provided about a concept.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier? Identifier[] - A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
- caseSensitive? boolean - If code comparison is case sensitive when codes within this system are compared to each other.
- versionNeeded? boolean - This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
- count? unsignedInt - The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
- 'version? string - The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.
- url? uri - An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.
- filter? CodeSystemFilter[] - A filter that can be used in a value set compose statement when selecting concepts using a filter.
- supplements? canonical - The canonical URL of the code system that this code system supplement is adding designations and properties to.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- compositional? boolean - The code system defines a compositional (post-coordination) grammar.
- name? string - A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- publisher? string - The name of the organization or individual that published the code system.
- useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
- status CodeSystemStatus - The date (and optionally time) when the code system resource was created or revised.
- never... - Rest field
health.fhir.r5: CodeSystemConcept
Closed record
FHIR CodeSystemConcept datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - A code - a text symbol - that uniquely identifies the concept within the code system.
- display? string - A human readable string that is the recommended default way to present this concept to a user.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- property? CodeSystemConceptProperty[] - A property value for this concept.
- definition? string - The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
- designation? CodeSystemConceptDesignation[] - Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- concept? CodeSystemConcept[] - Children of a concept to produce a hierarchy of concepts.
health.fhir.r5: CodeSystemConceptDesignation
Closed record
FHIR CodeSystemConceptDesignation datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- use? Coding - A code that details how this designation would be used.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language? code - The language this designation is defined for.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value string - The text value for this designation.
health.fhir.r5: CodeSystemConceptProperty
Closed record
FHIR CodeSystemConceptProperty datatype record.
Fields
- valueCoding? Coding - The value of this property.
- valueBoolean? boolean - The value of this property.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - A code that is a reference to CodeSystem.property.code.
- valueString? string - The value of this property.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueDecimal? decimal - The value of this property.
- valueCode? code - The value of this property.
- valueDateTime? dateTime - The value of this property.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger? integer - The value of this property.
health.fhir.r5: CodeSystemFilter
Closed record
FHIR CodeSystemFilter datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description? string - A description of how or why the filter is used.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value string - A description of what the value for the filter should be.
- operator CodeSystemFilterOperator[] - A list of operators that can be used with the filter.
health.fhir.r5: CodeSystemProperty
Closed record
FHIR CodeSystemProperty datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description? string - A description of the property- why it is defined, and how its value might be used.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeSystemPropertyType - The type of the property value. Properties of type 'code' contain a code defined by the code system (e.g. a reference to another defined concept).
- uri? uri - Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.
health.fhir.r5: Coding
Closed record
A Coding is a representation of a defined concept using a symbol from a defined "code system".
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- system? uri - Identity of the terminology system
- 'version? string - Version of the system - if relevant
- code? code - Symbol in syntax defined by the system
- display? string - Representation defined by the system
- userSelected? boolean - If this coding was chosen directly by the user
health.fhir.r5: CodingExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCoding Coding -
health.fhir.r5: CommonSearchParameterDefinition
Common search parameter definition
Fields
- Fields Included from *FHIRSearchParameterDefinition
- name string
- type FHIRSearchParameterType
- base string[]
- expression string|()
- anydata...
- default anydata|SearchParameterDefaultValueProcessor?(default ()) - Default value
- multipleParams boolean(default false) - Multiple occurences may happen in the request
- effectiveLevel SearchParameterEffectiveLevel - Search parameter effective level
- preProcessor CommonSearchParameterPreProcessor? - Pre processor function
- postProcessor CommonSearchParameterPostProcessor? - Post processor function
health.fhir.r5: CompositeSearchParameter
Composite type search parameter information record.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- valuereadonly string - Composite search parameter value
health.fhir.r5: ContactDetail
Closed record
The ContactDetail structure defines general contact details.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- name? string - Name of an individual to contact
- telecom? ContactPoint[] - Contact details for individual or organization
health.fhir.r5: ContactDetailExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueContactDetail ContactDetail -
health.fhir.r5: ContactPoint
Closed record
Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- system? ContactPointSystem - [ phone | fax | email | pager | url | sms | other ] ContactPointSystem (Required) (http://hl7.org/fhir/valueset-contact-point-system.html)
- value? string - The actual contact point details
- use? ContactPointUse - [ home | work | temp | old | mobile ] - purpose of this contact point. ContactPointUse (Required) (http://hl7.org/fhir/valueset-contact-point-use.html)
- rank? positiveInt - Specify preferred order of use (1 = highest)
- period? Period - Time period when the contact point was/is in use
health.fhir.r5: ContactPointExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueContactPoint ContactPoint -
health.fhir.r5: ContainerDefinitionRecord
Represents definition of a FHIR resource.
Fields
- name string - Name of the resource
- baseType typedesc? - Type of the resource / abstract resource that is based on
- profile string? - profile url
- elements map<ElementAnnotationDefinition> - element definitions contained in the resource
- serializers ContainerSerializerCollection - Serializers of the resource
- validator? ResourceTypeValidationFunction - Validator for the resource
- processingMetaInfo? ProcessingMetaInfo - Meta information for processing the resource (This is included in intermediate user friendly FHIR models)
health.fhir.r5: ContainerSerializerCollection
Resource Serializer Collection.
Fields
- 'xml ContainerSerializerFunction - xml serializer
- 'json ContainerSerializerFunction - json serializer
health.fhir.r5: Contributer
Closed record
Contributor information Elements defined in Ancestors: id, extension
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type ContributerType - author | editor | reviewer | endorser ContributorType (Required)
- name string - Who contributed the content
- contact? ContactDetail[] - Contact details of the contributor
health.fhir.r5: Contributor
Closed record
Contributor information Elements defined in Ancestors: id, extension.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type ContributorType - author | editor | reviewer | endorser ContributorType (Required)
- name string - Who contributed the content
- contact? ContactDetail[] - Contact details of the contributor
health.fhir.r5: Count
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- countValue? integer -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: CountExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueCount Count -
health.fhir.r5: DataRequirement
Describes a required data item.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type code - The type of the required data
- profile? canonical[] - The profile of the required data
- subjectCodeableConcept? CodeableConcept - Patient, Practitioner, RelatedPerson, Organization, Location, Device
- subjectReference? Reference - Patient, Practitioner, RelatedPerson, Organization, Location, Device
- mustSupport? string[] - Indicates specific structure elements that are referenced by the knowledge module
- codeFilter? ElementCodeFilter[] - What codes are expected
- dateFilter? ElementDateFilter[] - What dates/date ranges are expected
- 'limit? positiveInt - Number of results
- sort? ElementSort[] - Order of the results
health.fhir.r5: DataRequirementExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDataRequirement DataRequirement -
health.fhir.r5: DataTypeDefinitionRecord
Definition if a FHIR complex data type.
Fields
- name string - Name of the data type
- baseType typedesc? - Base Data type that this data type is based on (extended from)
- elements map<ElementAnnotationDefinition> - Child elements of the defined data type
- serializers DataTypeSerializerCollection - Serializer of the data type
- validator? DataTypeValidationFunction - Validator for the data type
- processingMetaInfo? ProcessingMetaInfo - Meta information for processing the data entry (This is included in intermediate user friendly FHIR models)
health.fhir.r5: DataTypeSerializerCollection
Data type serializer collection.
Fields
- 'xml DataTypeSerializerFunction - xml serializer
- 'json DataTypeSerializerFunction - json serializer
health.fhir.r5: DateExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDate date -
health.fhir.r5: DateSearchParameter
Date type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- prefixreadonly Prefix - Prefix attached with date type search parameter
- valuereadonly Civil - Value of the received search parameter
health.fhir.r5: DateTimeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDateTime dateTime -
health.fhir.r5: DecimalExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDecimal decimal -
health.fhir.r5: Distance
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- distanceValue? decimal -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: DistanceExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDistance Distance -
health.fhir.r5: DomainResource
A resource with narrative, extensions, and contained resources.
- Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources.
- Rule: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
- Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated.
- Rule: If a resource is contained in another resource, it SHALL NOT have a security label.
- Guideline: A resource should have narrative for robust management.
Fields
- Fields Included from *Resource
- text? Narrative - Text summary of the resource, for human interpretation
- contained? Resource[] - Contained, inline Resources
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored
health.fhir.r5: Dosage
Closed record
How the medication is/was taken or should be taken.
Fields
- Fields Included from *BackboneType
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
- sequence? integer - The order of the dosage instructions
- text? string - Free text dosage instructions e.g. SIG
- addtionalInstruction? CodeableConcept[] - Supplemental instruction or warnings to the patient - e.g. with meals,may cause drowsiness
- patientInstruction? string - Patient or consumer oriented instructions
- timing? Timing - When medication should be administered
- asNeededBoolean? boolean - Take as needed
- asNeededCodeableConcept? CodeableConcept - Take as needed
- site? CodeableConcept - Body site to administer to
- route? CodeableConcept - How drug should enter body
- method? CodeableConcept - Technique for administering medication
- doseAndRate? ElementDoseAndRate[] - Amount of medication administered
- maxDosePerPeriod? Ratio - Upper limit on medication per unit of time
- maxDosePerAdministration? SimpleQuantity - Upper limit on medication per administration
- maxDosePerLifetime? SimpleQuantity - Upper limit on medication per lifetime of the patient
health.fhir.r5: DosageExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDosage Dosage -
health.fhir.r5: Duration
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- durationValue? decimal -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: DurationExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueDuration Duration -
health.fhir.r5: Element
The base definition for all elements contained inside a resource.
Fields
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- Element... - Rest field
health.fhir.r5: ElementAnnotationDefinition
Element definition.
Fields
- name string - Name of the element
- dataType typedesc - Data type of the element
- min int - Minimum Cardinality
- max int - Maximum Cardinality (a number or *). In ballerina * is represented by maximum int value
- isArray boolean - Is this element holds array (is cardinality > 1)
- description? string - Description of the elemenet
- path? string - FHIR path pf the element respective to the parent
- valueSet? string - If coded values are bound to a ValueSet
- mustSupport? boolean - The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system
health.fhir.r5: ElementBase
Closed record
Base definition information for tools.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- path string - Path that identifies the base element
- min unsignedInt - Min cardinality of the base element
- max string - Max cardinality of the base element
health.fhir.r5: ElementBinding
Closed record
ValueSet details if this is coded.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- strength StrengthCode - required | extensible | preferred | example
- description? string - Human explanation of the value set
- valueSet? canonical - Source of value set
health.fhir.r5: ElementCodeFilter
Closed record
What codes are expected.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- path? string - A code-valued attribute to filter on
- searchParam? string - A coded (token) parameter to search on
- valueSet? canonical - Valueset for the filter
- code? Coding[] - What code is expected
health.fhir.r5: ElementConstraint
Closed record
Condition that must evaluate to true.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- key id - Target of 'condition' reference above
- requirements? string - Why this constraint is necessary or appropriate
- severity string - error | warning
- human string - Human description of constraint
- expression? string - FHIRPath expression of constraint
- xpath? string - XPath expression of constraint
- 'source? canonical - Reference to original source of constraint
health.fhir.r5: ElementDateFilter
Closed record
What dates/date ranges are expected.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- path? string - A date-valued attribute to filter on
- searchParam? string - A date valued parameter to search on
- valueDateTime? dateTime - The value of the filter, as a DateTime
- valuePeriod? Period - The value of the filter, as a Period
- valueDuration? Duration - The value of the filter, as a Duration value
health.fhir.r5: ElementDefinition
Closed record
Definition of an element in a resource or extension.
Fields
- Fields Included from *BackboneType
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Additional content defined by implementations
- path string - Path of the element in the hierarchy of elements
- representation? code[] - xmlAttr | xmlText | typeAttr | cdaText | xhtml
- sliceName? string - Name for this particular element (in a set of slices)
- sliceIsConstraining? boolean - If this slice definition constrains an inherited slice definition (or not)
- label? string - Name for element to display with or prompt for element
- code? Coding[] - Corresponding codes in terminologies
- slicing? ElementSlicing - This element is sliced - slices follow
- short? string - Concise definition for space-constrained presentation
- definition? markdown - Full formal definition as narrative text
- comment? markdown - Comments about the use of this element
- requirements? markdown - Why this resource has been created
- alias? string[] - Other names
- min? unsignedInt - Minimum Cardinality
- max? string - Maximum Cardinality
- base? ElementBase - Base definition information for tools
- contendReference? uri - Reference to definition of content for the element
- 'type? ElementType[] - Data type and Profile for this element
- defaultValue? Element - Specified value if missing from instance
- meaningWhenMissing? markdown - Implicit meaning when this element is missing
- orderMeaning? string - What the order of the elements means
- fixed? Element - Value must be exactly this
- pattern? Element - Value must have at least these property values
- example? ElementExample[] - Example value (as defined for type)
- minValueDate? date - Minimum Allowed Value for date
- minValueDateTime? dateTime - Minimum Allowed Value for datetime
- minValueInstant? instant - Minimum Allowed Value for instant
- minValueTime? time - Minimum Allowed Value for time
- minValueDecimal? decimal - Minimum Allowed Value for decimal
- minValueInteger? integer - Minimum Allowed Value for integer
- minValuePositiveInt? positiveInt - Minimum Allowed Value for positiveint
- minValueUnsignedInt? unsignedInt - Minimum Allowed Value for unsignedint
- minValueQuantity? Quantity - Minimum Allowed Value for quantity
- maxValueDate? date - Maximum Allowed Value for date
- maxValueDateTime? dateTime - Maximum Allowed Value for datetime
- maxValueInstant? instant - Maximum Allowed Value for instant
- maxValueTime? time - Maximum Allowed Value for time
- maxValueDecimal? decimal - Maximum Allowed Value for decimal
- maxValueInteger? integer - Maximum Allowed Value for integer
- maxValuePositiveInt? positiveInt - Maximum Allowed Value for positiveint
- maxValueUnsignedInt? unsignedInt - Maximum Allowed Value for unsignedint
- maxValueQuantity? Quantity - Maximum Allowed Value for quantity
- maxLength? integer - Maximum Allowed Value for length
- condition? id[] - Reference to invariant about presence
- constraint? ElementConstraint[] - Condition that must evaluate to true
- mustSupport? boolean - If the element must be supported
- isModifier? boolean - If this modifies the meaning of other elements
- isModifierReason? string - Reason that this element is marked as a modifier
- isSummary? boolean - Include when _summary = true?
- binding? ElementBinding - ValueSet details if this is coded
- mapping? ElementMapping[] - Map element to another set of definitions
health.fhir.r5: ElementDiscriminator
Closed record
Element values that are used to distinguish the slices.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type ElementDiscriminatorType - value | exists | pattern | type | profile
- path string - Path to element value
health.fhir.r5: ElementDoseAndRate
Closed record
Amount of medication administered.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type? CodeableConcept - The kind of dose or rate specified
- doseRange? Range - Amount of medication per dose
- doseQuantity? SimpleQuantity - Amount of medication per dose
- rateRatio? Ratio - Amount of medication per unit of time
- rateRange? Range - Amount of medication per unit of time
- rateQuantity? SimpleQuantity - Amount of medication per unit of time
health.fhir.r5: ElementExample
Closed record
Example value (as defined for type).
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- label string - Describes the purpose of this example
- value Element - Value of Example (one of allowed types)
health.fhir.r5: ElementMapping
Closed record
Map element to another set of definitions.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- identity id - Reference to mapping declaration
- language? code - Computable language of mapping
- 'map string - Details of the mapping
- comment? string - Comments about the mapping or its use
health.fhir.r5: ElementRepeat
When the event is to occur.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- boundsDuration? Duration - (Start and/or end) limits
- boundsRange? Range - Range of lengths
- boundsPeriod? Period - Range of lengths, or (Start and/or end) limits
- count? positiveInt - Number of times to repeat
- countMax? positiveInt - Maximum number of times to repeat
- duration? decimal - How long when it happens
- durationMax? decimal - How long when it happens (Max)
- durationUnit? Timecode - Funit of time (UCUM) UnitsOfTime (Required)
- frequency? positiveInt - Event occurs frequency times per period
- frequencyMax? positiveInt - Event occurs up to frequencyMax times per period
- period? decimal - Event occurs frequency times per period
- periodMax? decimal - Upper limit of period (3-4 hours)
- periodUnit? Timecode - unit of time (UCUM)UnitsOfTime (Required)
- dayOfWeek? Daycode[] - DaysOfWeek (Required)
- timeOfDay? time[] - Time of day for action
- when? code[] - Code for time period of occurrence EventTiming (Required)
- offset? unsignedInt - Minutes from event (before or after)
health.fhir.r5: ElementSlicing
Closed record
This element is sliced - slices follow.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- discriminator? ElementDiscriminator[] - Element values that are used to distinguish the slices
- description? string - Text description of how slicing works (or not)
- ordered? boolean - If elements must be in same order as slices
- rules ElementSlicingRules - closed | open | openAtEnd
health.fhir.r5: ElementSort
Closed record
Order of the results.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- path string - The name of the attribute to perform the sort
- direction DirectionCode - ascending | descending
health.fhir.r5: ElementType
Closed record
Data type and Profile for this element.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- code uri - Data type or Resource (reference to definition)
- profile? canonical[] - Profiles (StructureDefinition or IG) - one must apply
- targetProfile? canonical[] - Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
- aggregation? TypeAggregation[] - contained | referenced | bundled - how aggregated
- versioning? TypeVersioning - either | independent | specific
health.fhir.r5: Expression
An expression that can be used to generate a value.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- description? string - Natural language description of the condition
- name? id - Short name assigned to expression for reuse
- language code - text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.
- expression? string - Expression in specified language
- reference? uri - Where the expression is found
health.fhir.r5: ExpressionExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueExpression Expression -
health.fhir.r5: ExtendedContactDetail
Closed record
Fields
- purpose? CodeableConcept -
- name? HumanName -
- telecom? ContactPoint -
- address? Address -
- organization? Reference -
- period? Period -
health.fhir.r5: ExtendedContactDetailExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueExtendedContactDetail ExtendedContactDetail -
health.fhir.r5: ExtensionExtension
Closed record
Every element in a resource or data type includes an optional "extension" child element that may be present any number of times.
Fields
- Fields Included from *Element
- url uri - identifies the meaning of the extension
- extension? Extension[] - Additional content defined by implementations
health.fhir.r5: FHIRCreateInteraction
FHIR Create interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction CREATE(default CREATE) - Interaction type
health.fhir.r5: FHIRErrorDetail
FHIR error details record.
Fields
- issues [FHIRIssueDetail, FHIRIssueDetail...] - FHIR issues
- internalError boolean(default false) - flag to indicate the FHIRError is an internal error
- httpStatusCode int(default http:STATUS_INTERNAL_SERVER_ERROR) - HTTP status code to return to the client
- uuid string(default uuid:createType1AsString()) - UUID of the error
health.fhir.r5: FHIRInteraction
FHIR Interaction.
Fields
- interaction FHIRInteractionType - Interaction type
health.fhir.r5: FHIRIssueDetail
FHIR Error Detail structure.
Fields
- severity Severity - severity of the issue
- code IssueType - Error or warning code
- details CodeableConcept?(default ()) - Additional details about the error
- diagnostic string?(default ()) - Additional diagnostic information about the issue
- expression string[]?(default ()) - FHIRPath of element(s) related to issue
health.fhir.r5: FHIROperationDefinition
Closed record
Operation definition representing summary information required for processing from spec.
Fields
- name string - name of the operation
- instanceLevel boolean - active in instance interaction level
- typeLevel boolean - active in type interaction level
- systemLevel boolean - active in system interaction level
- affectsState? boolean - whether the operation affects the state of the server
- 'resource? string[] - resource types on which the operation applies
- 'parameter? FHIROperationParameterDefinition[] - parameters of the operation
health.fhir.r5: FHIROperationInteraction
FHIR Operation interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction OPERATION(default OPERATION) - Interaction type
- operation string - Operation name
health.fhir.r5: FHIROperationParameterDefinition
Operation search param definition representing summary parameter information required for processing from spec.
Fields
- name string - name of the operation parameter
- use OperationParameterUse - whether the operation parameter is an input or an output parameter
- min int - minimum cardinality
- max string - maximum cardinality
- documentation? string - description of the operation parameter
- 'type? string - type of the operation parameter
- searchType? FHIRSearchParameterType - search type of the operation parameter
- part? FHIROperationParameterDefinition[] - parts of the operation parameter
health.fhir.r5: FHIRReadInteraction
FHIR Read interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction READ(default READ) - Interaction type
- id string - target resource id
health.fhir.r5: FHIRRequestMimeHeaders
Closed record
Holds information about MIME details of the request.
Fields
- contentType FHIRPayloadFormat?(default ()) - request content type
- acceptType FHIRPayloadFormat(default JSON) - request accept type, JSON will be set as default
health.fhir.r5: FHIRSearchInteraction
FHIR Search interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction SEARCH(default SEARCH) - Interaction type
- defaultProfile? string - International resource URL will set as default.
health.fhir.r5: FHIRSearchParameterDefinition
Search parameter definition representing summary information reqiored for processing from spec.
Fields
- name string - name of the search parameter
- 'type FHIRSearchParameterType - type of the search parameter
- base string[] - The resource type this search parameter applies to
- expression string? - expression bound to the resource type
health.fhir.r5: FHIRSecurity
Record to hold information about FHIR related security.
Fields
- securedAPICallreadonly boolean - indicate whether the API call is originated from secured API or not
- fhirUser readonly & FHIRUser? - FHIR User information
- jwt readonly & JWT? - decoded JWT assertion
health.fhir.r5: FhirServerAPIsConfig
Closed record
FHIR Server APIs configuration.
Fields
- apisreadonly map<ResourceAPIConfig> - FHIR APIs configuration
- paginationConfigreadonly PaginationConfig(default { enabled: true }) - Pagination configuration
- basePath?readonly string - Base path of the FHIR server
health.fhir.r5: FHIRTypedSearchParameter
Base type of decoded/processed search parameter value.
Fields
- modifierreadonly FHIRSearchParameterModifier|string? - FHIR Search parameter modifier
health.fhir.r5: FHIRUpdateInteraction
FHIR Update interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction UPDATE(default UPDATE) - Interaction type
- id string - Target resource id
health.fhir.r5: FHIRUser
Record to wrap JWT user information.
Fields
- scopes readonly & string[] - The list of scopes the particular user have.
- userIDreadonly string - Unique user identifier.
health.fhir.r5: HTTPRequest
Record Holding information about the HTTP request.
Fields
health.fhir.r5: HumanName
Closed record
Name of a human or other living entity - parts and usage.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- use? HumanNameUse - usual | official | temp | nickname | anonymous | old | maiden
- text? string - Text representation of the full name
- family? string - Family name (often called 'Surname')
- given? string[] - Given names (not always 'first'). Includes middle names. This repeating element order: Given Names appear in the correct order for presenting the name
- prefix? string[] - Parts that come before the name. This repeating element order: Prefixes appear in the correct order for presenting the name
- suffix? string[] - Parts that come after the name. This repeating element order: Suffixes appear in the correct order for presenting the name
- period? Period - Time period when name was/is in use
health.fhir.r5: HumanNameExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueHumanName HumanName -
health.fhir.r5: Identifier
Closed record
A numeric or alphanumeric string that is associated with a single object or entity within a given system.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- use? IdentifierUse - usual | official | temp | secondary | old (If known) IdentifierUse (Required) (http://hl7.org/fhir/valueset-identifier-use.html)
- 'type? CodeableConcept - Description of identifier
- system? uri - The namespace for the identifier value
- value? string - The value that is unique
- period? Period - Time period when id is/was valid for use
- assigner? Reference - Organization that issued id (may be just text)
health.fhir.r5: IdentifierExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueIdentifier Identifier -
health.fhir.r5: IdExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueId id -
health.fhir.r5: IGInfoRecord
Closed record
Record to hold information about an implementation guide.
Fields
- titlereadonly string - Name for this implementation guide (human friendly)
- namereadonly string - Name for this implementation guide (computer friendly)
- terminology Terminology - terminology object
- searchParameters readonly & map<FHIRSearchParameterDefinition[]>[] - search parameters defined in the IG (key: parameter name)
- operations? readonly & map<FHIROperationDefinition[]> - operations defined in the IG (key: operation name)
health.fhir.r5: Information
Closed record
Information about a rest feature.
Fields
- descriptionreadonly string - Description
- builtin?readonly boolean - Is this feature is available as a built-in feature
- documentation?readonly string - Documentation link
health.fhir.r5: InstantExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueInstant instant -
health.fhir.r5: Integer64Extension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueInteger64 integer64 -
health.fhir.r5: IntegerExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueInteger integer -
health.fhir.r5: InternalAuditEvent
Closed record
Flattened version of the FHIR AuditEvent (http://hl7.org/fhir/R5/auditevent.html).
Fields
- typeCode string - FHIR AuditEvent.type.code (Value Set http://hl7.org/fhir/ValueSet/audit-event-type)
- subTypeCode string - FHIR AuditEvent.subtype.code (Value Set http://hl7.org/fhir/ValueSet/audit-event-sub-type)
- actionCode string - FHIR AuditEvent.action (Value Set http://hl7.org/fhir/ValueSet/audit-event-action)
- outcomeCode string - FHIR AuditEvent.outcome (Value Set http://hl7.org/fhir/ValueSet/audit-event-outcome)
- recordedTime string - FHIR AuditEvent.recorded
- agentType string - FHIR AuditEvent.agent.type.coding.code (Value Set http://hl7.org/fhir/ValueSet/participation-role-type)
- agentName string - FHIR AuditEvent.agent.who.display
- agentIsRequestor boolean - FHIR AuditEvent.agent.requestor
- sourceObserverName string - FHIR AuditEvent.source.observer.display
- sourceObserverType string - FHIR AuditEvent.source.observer.type (Value Set http://hl7.org/fhir/ValueSet/audit-source-type)
- entityType string - FHIR AuditEvent.entity.type.coding.code (Value Set http://hl7.org/fhir/ValueSet/audit-entity-type)
- entityRole string - FHIR AuditEvent.entity.role.coding.code (Value Set http://hl7.org/fhir/ValueSet/object-role)
- entityWhatReference string - FHIR AuditEvent.entity.what.reference (Requested relative path - eg.: "Patient/example/_history/1")
health.fhir.r5: JWT
Record holding Decoded JWT content.
Fields
- header readonly & Header - JWT header
- payload readonly & Payload - JWT payload
health.fhir.r5: Mapping
Record type to hold relocation mapping information.
Fields
- sourcePath string - FHIR path to source
- targetPath string - FHIR path to target location
health.fhir.r5: MarkdownExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueMarkdown markdown -
health.fhir.r5: MarketingStatus
Closed record
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
Fields
- Fields Included from *BackboneElement
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Additional content defined by implementations
- country? CodeableConcept - The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
- jurisdiction? CodeableConcept - "Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
- status CodeableConcept - This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
- dateRange? Period - The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder " +(or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market refers to the release of the Medicinal Product into the distribution chain
- restoreDate? dateTime - The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
health.fhir.r5: Meta
Closed record
Each resource contains an element "meta", of type "Meta", which is a set of metadata that provides technical and workflow context to the resource.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- versionId? id - Version specific identifier
- lastUpdated? instant - When the resource version last changed
- 'source? uri - Identifies where the resource comes from
- profile? canonical[] - Profiles this resource claims to conform to
- security? Coding[] - Security Labels applied to this resource SecurityLabels(http://hl7.org/fhir/valueset-security-labels.html) (Extensible)
- tag? Coding[] - Tags applied to this resource Common Tags(http://hl7.org/fhir/valueset-common-tags.html) (Example)
health.fhir.r5: MetaExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueMeta Meta -
health.fhir.r5: MonetaryComponent
Closed record
Fields
- Fields Included from *Element
- id? string -
- extension? Extension[] -
- amount? Money -
- code? CodeableConcept -
- factor? decimal -
- 'type MonetaryComponentType -
health.fhir.r5: Money
Closed record
An amount of economic utility in some recognized currency.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- value? decimal - Numerical value (with implicit precision)
- currency? code - ISO 4217 Currency Code (Required) (https://hl7.org/fhir/valueset-currencies.html)
health.fhir.r5: MoneyExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueMoney Money -
health.fhir.r5: MoneyQuantity
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- moneyValue? decimal -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: Narrative
Closed record
Human-readable summary of the resource (essential clinical and business information).
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- status StatusCode - [generated | extensions | additional | empty] NarrativeStatus(http://hl7.org/fhir/valueset-narrative-status.html) (Required)
- div xhtml - Limited xhtml content
- Rule: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
- Rule: The narrative SHALL have some non-whitespace content
health.fhir.r5: NotAvailableTime
Closed record
Fields
- Fields Included from *Element
- id? string -
- extension? Extension[] -
- description? string -
- during? Period -
health.fhir.r5: NumberSearchParameter
Number type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- prefixreadonly Prefix(default eq) - prefix is used to control the nature of the matching
health.fhir.r5: OidExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueOid oid -
health.fhir.r5: OperationConfig
Closed record
Operation configuration.
Fields
- namereadonly string - Name of the operation
- activereadonly boolean - Is this operation is activated or deactivated
- parameters?readonly OperationParamConfig[] - Parameters of the operation
- preProcessor? readonly & OperationPreProcessor - Override this operation pre-processing function. If the integration developer wants to take control of pre-processing the operation.
- postProcessor? readonly & OperationPostProcessor - Override this operation post-processing function. If the integration developer wants to take control of post-processing the operation.
- information?readonly Information - Meta information about the operation (no processed, just for information)
health.fhir.r5: OperationOutcome
FHIR OperationOutcome resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_OPERATIONOUTCOME(default RESOURCE_NAME_OPERATIONOUTCOME) - The type of the resource describes
- meta BaseOperationOutcomeMeta(default { profile : [PROFILE_BASE_OPERATIONOUTCOME] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- issue OperationOutcomeIssue[] - An error, warning, or information message that results from a system action.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- language? code - The base language in which the resource is written.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- never... - Rest field
health.fhir.r5: OperationOutcomeIssue
Closed record
FHIR OperationOutcomeIssue datatype record.
Fields
- severity OperationOutcomeIssueSeverity - Indicates whether the issue indicates a variation from successful processing.
- diagnostics? string - Additional diagnostic information about the issue.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
- expression? string[] - A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- details? CodeableConcept - Additional details about the error. This may be a text description of the error or a system code that identifies the error.
- location? string[] - This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be 'http.' + the parameter name.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r5: OperationParamConfig
Closed record
Operation parameter configuration.
Fields
- namereadonly string - Name of the operation parameter
- activereadonly boolean - Whether this operation parameter is activated or deactivated
- scopes?readonly FHIRInteractionLevel[] - Scopes the operation parameter is applicable to
- min?readonly int - Minimum number of values the parameter can have (min cardinality)
- max?readonly string - Maximum number of values the parameter can have (max cardinality)
- parts?readonly OperationParamConfig[] - Nested parts of the operation parameter
- information?readonly Information - Meta information about the operation parameter
health.fhir.r5: PaginationConfig
Closed record
Pagination configs.
Fields
- enabledreadonly boolean - Whether pagination is enabled or not
- pageSizereadonly int(default 10) - Number of records per page
health.fhir.r5: PaginationContext
Closed record
Record to hold pagination related info in fhir context.
Fields
- paginationEnabledreadonly boolean - Whether pagination is enabled or not
- pagereadonly int - Page number
- pageSizereadonly int - Page size
health.fhir.r5: ParameterDefinition
Closed record
Definition of a parameter to a module.
Fields
- Fields Included from *Element
- id? string - Unique id for the element within a resource (for internal references)
- extension? Extension[] - Additional Content defined by implementations
- name? code - Name used to access the parameter value
- use ParameterDefinitionUse - in | out
- min? integer - Minimum cardinality
- max? string - Maximum cardinality (a number of *)
- documentation? string - A brief description of the parameter
- 'type code - What type of value
- profile? canonical - What profile the value is expected to be
health.fhir.r5: ParameterDefinitionExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueParameterDefinition ParameterDefinition -
health.fhir.r5: Period
Closed record
A time period defined by a start and end date/time.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'start? dateTime - Starting time with inclusive boundary
- end? dateTime - End time with inclusive boundary, if not ongoing
health.fhir.r5: PeriodExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valuePeriod Period -
health.fhir.r5: Population
Closed record
A definition of a set of people that apply to some clinically related context, for example people contraindicated for a certain medication.
Fields
- Fields Included from *BackboneElement
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
- ageRange? Range - The age range of the specific population
- ageCodeableConcept? CodeableConcept - The age concept of the specific population
- gender? CodeableConcept - The gender of the specific population
- race? CodeableConcept - Race of the specific population
- physiologicalCondition? CodeableConcept - The existing physiological conditions of the specific population to which this applies
health.fhir.r5: PositiveIntExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valuePositiveInt positiveInt -
health.fhir.r5: ProcessingMetaInfo
Record type to hold meta information used for processing the entity.
Fields
- targetModel? typedesc - target resource model or data model
- relocations? Mapping[] - mappings entries from source model (this) to target model
health.fhir.r5: ProdCharacteristic
Closed record
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
Fields
- Fields Included from *BackboneElement
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
- height? Quantity - height can be specified using a numerical value and its unit of measurement
- width? Quantity - width can be specified using a numerical value and its unit of measurement
- depth? Quantity - depth can be specified using a numerical value and its unit of measurement
- weight? Quantity - weight can be specified using a numerical value and its unit of measurement
- nominalValue? Quantity - nominal volume can be specified using a numerical value and its unit of measurement
- externalDiameter? Quantity - Number of sample points at each time point
- shape? string - shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
- color? string - color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
- imprint? string - Where applicable, the imprint can be specified as text
- image? Attachment - shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
- scoring? CodeableConcept - the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
health.fhir.r5: ProductShelfLife
Closed record
The shelf-life and storage information for a medicinal product item or container can be described using this class.
Fields
- Fields Included from *BackboneElement
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Additional content defined by implementations
- identifier? Identifier - Unique identifier for the packaged Medicinal Product
- 'type CodeableConcept - This describes the shelf life, taking into account various scenarios such as shelf life of the packaged
- period Quantity - The shelf life time period can be specified using a numerical value for the period of time and its unit of
time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology
The symbol and the symbol identifier shall be used
- specialPrecautionsForStorage? CodeableConcept[] - Special precautions for storage, if any, can be specified using an appropriate controlled
vocabulary The controlled term and the controlled term identifier shall be specified
health.fhir.r5: Profile
Closed record
Represents a profile, containing summary information.
Fields
- url string - Canonical identifier for this structure definition, represented as a URI (globally unique)
- resourceType string - FHIR resource type
- modelType typedesc<anydata> - ballerina model type which is used to represent instance of this profile
health.fhir.r5: Quantity
Closed record
A measured or measurable amount Rule: If a code for the unit is present, the system SHALL also be present Elements defined in Ancestors: id, extension
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- value? decimal - Numerical value (with implicit precision)
- comparator? QuantityComparatorCode - < | <= | >= | > - how to understand the value
- unit? string - Unit representation
- system? uri - System that defines coded unit form
- code? code - Coded form of the unit
health.fhir.r5: QuantityExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueQuantity Quantity -
health.fhir.r5: QuantitySearchParameter
A quantity parameter searches on the Quantity data type.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- prefixreadonly Prefix? - Prefix to the parameter value may be used to control the nature of the matching
- systemreadonly string? - System that defines coded unit form
- codereadonly string? - Coded form of the unit
health.fhir.r5: Range
Closed record
Set of values bounded by low and high. Rule: If present, low SHALL have a lower value than high Elements defined in Ancestors: id, extension
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- low? SimpleQuantity - Low limit
- high? SimpleQuantity - High limit
health.fhir.r5: RangeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueRange Range -
health.fhir.r5: Ratio
Closed record
A ratio of two Quantity values - a numerator and a denominator Rule: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- numerator? SimpleQuantity - Numerator value
- denominator? SimpleQuantity - Denominator value
health.fhir.r5: RatioExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueRatio Ratio -
health.fhir.r5: RatioRange
Closed record
DesRange of ratio values Rule: One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present Rule: If present, lowNumerator SHALL have a lower value than highNumerator Elements defined in Ancestors: id, extensioncription.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- highNumerator? SimpleQuantity - High Numerator value
- lowNumerator? SimpleQuantity - Low Numerator value
- denominator? SimpleQuantity - Denominator value
health.fhir.r5: RatioRangeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueRatioRange RatioRange -
health.fhir.r5: Reference
Closed record
A reference from one resource to another.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- reference? string - Literal reference, Relative, internal or absolute URL
- Rule : SHALL have a contained resource if a local reference is provided
- 'type? string - Type the reference refers to (e.g. Patient) ResourceType(http://hl7.org/fhir/valueset-resource-types.html) (Extensible)
- identifier? Identifier - Logical reference, when literal reference is not known
- display? string - Text alternative for the resource
health.fhir.r5: ReferenceExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueReference Reference -
health.fhir.r5: ReferenceRange
Closed record
Reference range of possible or expected values
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- lowLimit? Quantity - Lower limit possible or expected
- highLimit? Quantity - Upper limit possible or expected
health.fhir.r5: ReferenceSearchParameter
Reference type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- resourceTypereadonly string? - Referenced resource type
- idreadonly string? - The logical [id] of a resource using a local reference (i.e. a relative reference)
- urlreadonly string? - Absolute URL - a reference to a resource by its absolute location
health.fhir.r5: RelatedArtifact
Closed record
Related artifacts for a knowledge resource.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type code - documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
- label? string - Short label
- display? string - Brief description of the related artifact
- citation? markdown - Bibliographic citation for the artifact
- url? urlType - Where the artifact can be accessed
- document? Attachment - What document is being referenced
- 'resource? canonical - What resource is being referenced
health.fhir.r5: RelatedArtifactExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueRelatedArtifact RelatedArtifact -
health.fhir.r5: RequestQueryParameter
Closed record
Represents incoming FHIR request search parameter
Fields
- originalName string - Original incoming request query param name
- name string - Name of the search parameter (FHIR)
- modifier FHIRSearchParameterModifier|string? - Search parameter modifier
- values string[] - Values of the query parameter
health.fhir.r5: RequestSearchParameter
Record type that holds original incoming values and processed information about the request search parameter.
Fields
- namereadonly string - Name of the search parameter (Key of the query parameter)
- valuereadonly string - Original incoming search parameter value in string format
- 'typereadonly FHIRSearchParameterType - Type of search parameter
- typedValuereadonly FHIRTypedSearchParameter - Parsed/Decoded search parameter value based on the type of the search parameter
health.fhir.r5: Resource
Base Resource.
Fields
- resourceType string - Type of resource
- id? string - Logical id of this artifact
- meta? Meta - Metadata about the resource
- implicitRules? uri - A set of rules under which this content was created
- language? code - Language of the resource content Common Languages(http://hl7.org/fhir/valueset-languages.html) (Preferred but limited to AllLanguages)
health.fhir.r5: ResourceAPIConfigType
Closed record
API Config representation.
Fields
- resourceTypereadonly string - FHIR resource type of the API
- profilesreadonly string[] - profiles supported by the API
- defaultProfilereadonly string? - default profile that the FHIR API is supporting
- searchParametersreadonly SearchParamConfig[] - Search parameters supported by the FHIR API
- operationsreadonly OperationConfig[] - Operations supported by the FHIR API
- serverConfigreadonly ServerConfig? - Serevr configuration
- authzConfigreadonly AuthzConfig? - Authorization service configuration
- auditConfig?readonly AuditConfig - Audit service configuration
- paginationConfigreadonly PaginationConfig(default { enabled: true }) - Pagination configuration
health.fhir.r5: ResourceDefinitionRecord
Represents definition of a FHIR resource.
Fields
- resourceType string - FHIR resource type
- baseType typedesc? - Type of the resource / abstract resource that is based on
- profile string? - profile url
- elements map<ElementAnnotationDefinition> - element definitions contained in the resource
- serializers ResourceSerializerCollection - Serializers of the resource
- validator? ResourceTypeValidationFunction - Validator for the resource
- processingMetaInfo? ProcessingMetaInfo - Meta information for processing the resource (This is included in intermediate user friendly FHIR models)
health.fhir.r5: ResourceSerializerCollection
Resource Serializer Collection.
Fields
- 'xml ResourceSerializerFunction - xml serializer
- 'json ResourceSerializerFunction - json serializer
health.fhir.r5: SampledData
Closed record
A series of measurements taken by a device Elements defined in Ancestors: id, extension.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- origin SimpleQuantity - Zero value and units
- period decimal - Number of milliseconds between samples
- factor? decimal - Multiply data by this before adding to origin
- lowerLimit? decimal - Lower limit of detection
- upperLimit? decimal - Upper limit of detection
- dimensions positiveInt - Number of sample points at each time point
- data? string - Decimal values with spaces, or E | U | L
health.fhir.r5: SampledDataExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueSampledData SampledData -
health.fhir.r5: SearchParamConfig
Closed record
Search parameter configuration.
Fields
- namereadonly string - Name of the search parameter
- activereadonly boolean - Is this search parameter is activated or deactivated
- 'type? FHIRSearchParameterType -
- expression? string - Expression to be used to evaluate the search parameter
- preProcessor? readonly & SearchParameterPreProcessor - Override this search parameter pre-processing function. If the integration developer wants to take control of pre-processing the search parameter.
- postProcessor? readonly & SearchParameterPostProcessor - Override this search parameter post-processing function. If the integration developer wants to take control of post-processing the search parameter
- information?readonly Information - Meta infomation about the search parameter (no processed, just for information)
health.fhir.r5: ServerConfig
Closed record
FHIR Server configurations.
Fields
health.fhir.r5: Signature
Closed record
A Signature - XML DigSig, JWS, Graphical image of signature, etc.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type Coding[] - Indication of the reason the entity signed the object(s)
- when instant - When the signature was created
- who Reference - Who signed
- onBehalfOf? Reference - The party represented
- targetFormat? code - The technical format of the signed resources
- sigFormat? code - The technical format of the signature
- data? base64Binary - The actual signature content (XML DigSig. JWS, picture, etc.)
health.fhir.r5: SignatureExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueSignature Signature -
health.fhir.r5: SimpleData
Closed record
A series of measurements taken by a device Elements defined in Ancestors: id, extension.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- origin? SimpleQuantity - Zero value and units
- period? decimal - Number of milliseconds between samples
- factor? decimal - Multiply data by this before adding to origin
- lowerLimit? decimal - Lower limit of detection
- upperLimit? decimal - Upper limit of detection
- dimensions positiveInt - Number of sample points at each time point
- data? string - Decimal values with spaces, or E | U | L
health.fhir.r5: SimpleQuantity
Closed record
Fields
- Fields Included from *Quantity
- id? string -
- extension? Extension[] -
- value? decimal -
- unit? string -
- system? uri -
- code? code -
health.fhir.r5: SpecialSearchParameter
Special type search parameter information record.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- valuereadonly string - Composite search parameter value
health.fhir.r5: StringExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueString string -
health.fhir.r5: StringSearchParameter
String type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- valuereadonly string - Value of the received search parameter
health.fhir.r5: SubstanceAmount
Closed record
Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
Fields
- Fields Included from *BackboneElement
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
- amountQuantity? Quantity - Amount as a Quantity
- amountRange? Range - Field Amount as a Range
- amountString? string - Amount as a String
- amountType? CodeableConcept - Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because
- referenceRange? ReferenceRange - Reference range of possible or expected values
health.fhir.r5: TerminologyRecord
Closed record
Holds Terminology information.
Fields
- codeSystemsreadonly CodeSystem[] - CodeSystems belong to the terminology
- valueSetsreadonly ValueSet[] - ValueSets belong to the terminology
health.fhir.r5: TimeExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueTime time -
health.fhir.r5: Timing
Closed record
A timing schedule that specifies an event that may occur multiple times.
Fields
- Fields Included from *BackboneType
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- modifierExtension? Extension[] - Extensions that cannot be ignored even if unrecognized
- event? dateTime[] - When the event occurs
- repeat? ElementRepeat - When the event is to occur
- code? CodeableConcept - BID | TID | QID | AM | PM | QD | QOD | + TimingAbbreviation (Preferred)
health.fhir.r5: TimingExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueTiming Timing -
health.fhir.r5: TokenSearchParameter
Token type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- systemreadonly string? - The system property of the Identifier or Coding
- codereadonly string? - Value of Coding.code or Identifier.value
health.fhir.r5: TriggerDefinition
Closed record
Defines an expected trigger for a module.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- 'type code - named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
- name? string - Name or URI that identifies the event
- timingTiming? Timing - Timing of the event
- timingReference? Reference - Timing of the event
- timingDate? date - Timing of the event
- timingDateTime? dateTime - Timing of the event
- data? DataRequirement[] - Triggering data of the event (multiple = 'and')
- condition? Expression - Whether the event triggers (boolean expression)
health.fhir.r5: TriggerDefinitionExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueTriggerDefinition TriggerDefinition -
health.fhir.r5: UnsignedIntExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueUnsignedInt unsignedInt -
health.fhir.r5: UriExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueUri uri -
health.fhir.r5: URISearchParameter
URI type search parameter information.
Fields
- Fields Included from *FHIRTypedSearchParameter
- modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
- anydata...
- urireadonly uri - URI/URL/URN value
health.fhir.r5: UrlExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueUrl urlType -
health.fhir.r5: UsageContext
Closed record
Describes the context of use for a conformance or knowledge resource.
Fields
- Fields Included from *Element
- id? string - Unique id for inter-element referencing
- extension? Extension[] - Additional content defined by implementations
- code Coding - Type of context being specified
- valueCodeableConcept? CodeableConcept - Value that defines the context
- valueQuantity? Quantity - Value that defines the context
- valueRange? Range - Value that defines the context
- valueReference? Reference - Value that defines the context
health.fhir.r5: UsageContextExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueUsageContext UsageContext -
health.fhir.r5: UuidExtension
Closed record
Fields
- Fields Included from *Element
- url uri -
- valueUuid uuid -
health.fhir.r5: ValueSet
FHIR ValueSet resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_VALUESET(default RESOURCE_NAME_VALUESET) - The type of the resource describes
- meta BaseValueSetMeta(default { profile : [PROFILE_BASE_VALUESET] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- date? dateTime - The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
- copyright? markdown - A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- purpose? markdown - Explanation of why this value set is needed and why it has been designed as it has.
- jurisdiction? CodeableConcept[] - A legal or geographic region in which the value set is intended to be used.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description? markdown - A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
- experimental? boolean - A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- language? code - The base language in which the resource is written.
- title? string - A short, descriptive, user-friendly title for the value set.
- contact? ContactDetail[] - Contact details to assist a user in finding and communicating with the publisher.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- identifier? Identifier[] - A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
- 'version? string - The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- url? uri - An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
- expansion? ValueSetExpansion - A value set can also be 'expanded', where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- immutable? boolean - If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
- compose? ValueSetCompose - A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
- name? string - A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- publisher? string - The name of the organization or individual that published the value set.
- useContext? UsageContext[] - The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.
- status ValueSetStatus - The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
- never... - Rest field
health.fhir.r5: ValueSetCompose
Closed record
FHIR ValueSetCompose datatype record.
Fields
- include ValueSetComposeInclude[] - Include one or more codes from a code system or other value set(s).
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- inactive? boolean - Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- lockedDate? date - The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r5: ValueSetComposeInclude
Closed record
FHIR ValueSetComposeInclude datatype record.
Fields
- filter? ValueSetComposeIncludeFilter[] - Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- system? uri - An absolute URI which is the code system from which the selected codes come from.
- valueSet? canonical[] - Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.
- concept? ValueSetComposeIncludeConcept[] - Specifies a concept to be included or excluded.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system that the codes are selected from, or the special version '*' for all versions.
health.fhir.r5: ValueSetComposeIncludeConcept
Closed record
FHIR ValueSetComposeIncludeConcept datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code code - Specifies a code for the concept to be included or excluded.
- display? string - The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- designation? ValueSetComposeIncludeConceptDesignation[] - Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r5: ValueSetComposeIncludeConceptDesignation
Closed record
FHIR ValueSetComposeIncludeConceptDesignation datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- use? Coding - A code that represents types of uses of designations.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language? code - The language this designation is defined for.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value string - The text value for this designation.
health.fhir.r5: ValueSetComposeIncludeFilter
Closed record
FHIR ValueSetComposeIncludeFilter datatype record.
Fields
- op ValueSetComposeIncludeFilterOp - The kind of operation to perform as a part of the filter criteria.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- property code - A code that identifies a property or a filter defined in the code system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value string - The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.
health.fhir.r5: ValueSetExpansion
Closed record
FHIR ValueSetExpansion datatype record.
Fields
- identifier? uri - An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.
- contains? ValueSetExpansionContains[] - The codes that are contained in the value set expansion.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- total? integer - The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
- offset? integer - If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'parameter? ValueSetExpansionParameter[] - A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- timestamp dateTime - The time at which the expansion was produced by the expanding system.
health.fhir.r5: ValueSetExpansionContains
Closed record
FHIR ValueSetExpansionContains datatype record.
Fields
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code? code - The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
- inactive? boolean - If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).
- system? uri - An absolute URI which is the code system in which the code for this item in the expansion is defined.
- display? string - The recommended display for this item in the expansion.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- 'abstract? boolean - If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r5: ValueSetExpansionParameter
Closed record
FHIR ValueSetExpansionParameter datatype record.
Fields
- valueBoolean? boolean - The value of the parameter.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueString? string - The value of the parameter.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name string - Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.
- valueDecimal? decimal - The value of the parameter.
- valueUri? uri - The value of the parameter.
- valueCode? code - The value of the parameter.
- valueDateTime? dateTime - The value of the parameter.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger? integer - The value of the parameter.
health.fhir.r5: VirtualServiceDetail
Closed record
Fields
- Fields Included from *Element
- id? string -
- extension? Extension[] -
- sessionKey? string -
- addressUrl? urlType -
- additionalInfo? urlType[] -
- channelType? Coding -
- maxParticipants? positiveInt -
Errors
health.fhir.r5: FHIRError
Distinct
Base FHIR error type
health.fhir.r5: FHIRErrorType
Distinct
FHIR Error type
health.fhir.r5: FHIRParseError
FHIR validation related error
health.fhir.r5: FHIRProcessingError
FHIR processing related issue related error
health.fhir.r5: FHIRSerializerError
FHIR serializer error
health.fhir.r5: FHIRTypeError
FHIR data/resource type related error
health.fhir.r5: FHIRValidationError
FHIR validation related error
Object types
health.fhir.r5: TerminologyLoader
Distinct
Terminology loader definition
load
function load() returns Terminology|FHIRErrorUnion types
health.fhir.r5: Extension
Extension
health.fhir.r5: UsageContextValueX
UsageContextValueX
health.fhir.r5: FHIRWireFormat
FHIRWireFormat
FHIR wire content type formats
health.fhir.r5: AnyBaseResource
AnyBaseResource
Aggregated type of all resource type in this IG
Intersection types
health.fhir.r5: Terminology
Terminology
Record type ro represent terminology
health.fhir.r5: ResourceAPIConfig
ResourceAPIConfig
Redefined FHIR read-only FHIR resource API config
Function types
health.fhir.r5: 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.r5: OperationPostProcessor
function(FHIROperationDefinition, FHIRContext) returns (FHIRError?)OperationPostProcessor
Function type to be implemented to override the operation post-processing
health.fhir.r5: CodeSystemFinder
function(uri, code) returns (CodeSystem|ValueSet|FHIRError)CodeSystemFinder
Function definition for code system finder implementations
health.fhir.r5: DataTypeSerializerFunction
function(anydata, ElementAnnotationDefinition) returns ((FHIRWireFormat|FHIRSerializerError)?)DataTypeSerializerFunction
Function definition for data type serialization
health.fhir.r5: ResourceSerializerFunction
function(anydata) returns ((FHIRWireFormat|FHIRSerializerError)?)ResourceSerializerFunction
Function definition for FHIR resource serialization
health.fhir.r5: ContainerSerializerFunction
function(Bundle) returns ((FHIRWireFormat|FHIRSerializerError)?)ContainerSerializerFunction
Function definition for FHIR container resource serialization
health.fhir.r5: DataTypeValidationFunction
function(anydata, ElementAnnotationDefinition) returns (FHIRValidationError?)DataTypeValidationFunction
Function definition for FHIR data type validation
health.fhir.r5: ResourceTypeValidationFunction
function(anydata) returns (FHIRValidationError?)ResourceTypeValidationFunction
Function definition for FHIR resource validation
health.fhir.r5: SearchParameterPreProcessor
function(FHIRSearchParameterDefinition, string, RequestQueryParameter) returns (RequestSearchParameter[]|FHIRError)SearchParameterPreProcessor
Function type to be implemented to override the search parameter pre-processing
health.fhir.r5: SearchParameterPostProcessor
function(FHIRSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)SearchParameterPostProcessor
Function type to be implemented to override the search parameter post-processing
health.fhir.r5: CommonSearchParameterPreProcessor
function(CommonSearchParameterDefinition, RequestQueryParameter, ResourceAPIConfig) returns (RequestSearchParameter[]|FHIRError)CommonSearchParameterPreProcessor
common search parameter pre processor function
health.fhir.r5: CommonSearchParameterPostProcessor
function(CommonSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)CommonSearchParameterPostProcessor
common search parameter post processor function
health.fhir.r5: SearchParameterDefaultValueProcessor
function(CommonSearchParameterDefinition, ResourceAPIConfig) returns (anydata|FHIRError?)SearchParameterDefaultValueProcessor
String types
health.fhir.r5: 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.r5: 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.r5: base64Binary
base64Binary
A stream of bytes, base64 encoded (RFC 4648 )
- Regex:
(\s*([0-9a-zA-Z\+\=]){4}\s*)+
health.fhir.r5: 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.r5: 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.r5: 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.r5: 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.r5: 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.r5: 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.r5: id
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.r5: 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.r5: uuid
uuid
A UUID (aka GUID) represented as a URI; e.g. urn:uuid:c757873d-ec9a-4326-a141-556f43239520
health.fhir.r5: xhtml
xhtml
Description
health.fhir.r5: urlType
urlType
Description
Integer types
health.fhir.r5: 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.r5: positiveInt
positiveInt
Any positive integer in the range 1..2,147,483,647
- Regex:
+?[1-9][0-9]*
health.fhir.r5: unsignedInt
unsignedInt
Any non-negative integer in the range 0..2,147,483,647
- Regex:
[0]|([1-9][0-9]*)
health.fhir.r5: integer64
integer64
A signed integer in the range -9,223,372,036,854,775,808 to +9,223,372,036,854,775,807 (64-bit).
- Regex:
[0]|[-+]?[1-9][0-9]*
Map types
health.fhir.r5: SearchParamCollection
SearchParamCollection
Search parameter map (key: parameter name)
health.fhir.r5: OperationCollection
OperationCollection
Operation map (key: operation name)
Import
import ballerinax/health.fhir.r5;Other versions
0.9.0