health.fhir.r4
Module health.fhir.r4
API
Declarations
Definitions
ballerinax/health.fhir.r4 Ballerina library
FHIR R4 Base module
Sample Usage
This section focuses on samples depicting how to use this package to implement FHIR related integrations
Prerequisites
- Install Ballerina 2201.5.0 or later
Creating FHIR Resource models and serializing to JSON wire formats
Sample below is using the Patient resource in health.fhir.r4.internationa401
package.
import ballerina/log; import ballerina/time; import ballerinax/health.fhir.r4; import ballerinax/health.fhir.r4.internationa401; function createSamplePatient() returns json { internationa401:Patient patient = { meta: { lastUpdated: time:utcToString(time:utcNow()), profile: [internationa401:PROFILE_BASE_PATIENT] }, active: true, name: [{ family: "Doe", given: ["Jhon"], use: internationa401:official, prefix: ["Mr"] }], address: [{ line: ["652 S. Lantern Dr."], city: "New York", country: "United States", postalCode: "10022", 'type: internationa401:physical, use: internationa401:home }] }; r4:FHIRResourceEntity fhirEntity = new(patient); // Serialize FHIR resource record to Json payload json|r4:FHIRSerializerError jsonResult = fhirEntity.toJson(); if jsonResult is json { log:printInfo(string `Patient resource JSON payload : ${jsonResult.toString()}`); return jsonResult; } else { log:printError(string `Error occurred while serializing to JSON payload : ${jsonResult.message()}`, jsonResult); } }
Functions![](/images/permalink.svg)
annotationDataTypeValidationFunction![](/images/permalink.svg)
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![](/images/permalink.svg)
function clientErrorToFhirError(ClientError clientError) returns FHIRError
Convert a http client error to a FHIR error.
Parameters
- clientError ClientError - http:ClientError.
Return Type
- FHIRError - Return a FHIR error.
complexDataTypeJsonSerializer![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function createAbsoluteFhirReference(typedesc<anydata> referenceResourceModel, string absolutePathToReference) returns Reference|FHIRError
Create an absolute Reference to FHIR Resource.
Parameters
- referenceResourceModel typedesc<anydata> - FHIR Resource model of the Reference
- absolutePathToReference string - Absolute path to Reference
createContainedFhirReference![](/images/permalink.svg)
function createContainedFhirReference(map<anydata> targetResource, Resource resourceTypeReference) returns Reference|FHIRError
Create a contained Reference to FHIR Resource.
createFhirBundle![](/images/permalink.svg)
function createFhirBundle(BundleType t, DomainResource[] resources) returns Bundle
Create a FHIR Bundle.
Return Type
- Bundle - Return a FHIR Bundle.
createFHIRError![](/images/permalink.svg)
function createFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, FHIRErrorTypes? errorType, int httpStatusCode) returns FHIRError
Utility 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![](/images/permalink.svg)
function createInternalFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, FHIRErrorTypes? errorType) returns FHIRError
Utility 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![](/images/permalink.svg)
function createParserErrorFrom(FHIRError fhirError) returns FHIRParseError
Error 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![](/images/permalink.svg)
function createRelativeFhirReference(typedesc<anydata> referenceResourceModel, string relativePathToReference) returns Reference|FHIRError
Create a relative Reference to FHIR Resource.
Parameters
- referenceResourceModel typedesc<anydata> - FHIR Resource model of the Reference
- relativePathToReference string - Relative path to Reference
createRequestSearchParameter![](/images/permalink.svg)
function createRequestSearchParameter(FHIRSearchParameterDefinition|CommonSearchParameterDefinition definition, FHIRSearchParameterModifier|string? modifier, anydata value) returns RequestSearchParameter|FHIRError
dataFilterDataTypeValidationFunction![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function decodeFhirSearchParameters(string urlEncodedParams) returns map<RequestSearchParameter[] & readonly>|FHIRError
Parameters
- urlEncodedParams string -
decodeSearchParameterKey![](/images/permalink.svg)
function decodeSearchParameterKey(string paramName, string[] values) returns RequestQueryParameter|FHIRError
dosageDataTypeValidationFunction![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function errorToOperationOutcome(FHIRError fhirError) returns OperationOutcome
Utility function to create OperationOutcome from FHIRError.
Parameters
- fhirError FHIRError - FHIRError to be converted
Return Type
- OperationOutcome - created OperationOutcome record
executeResourceJsonSerializer![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function extractActiveSearchParameterNames(map<SearchParamConfig> paramConfig) returns string[]
Parameters
- paramConfig map<SearchParamConfig> -
fhirBundleJsonSerializer![](/images/permalink.svg)
function fhirBundleJsonSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?
Parameters
- data Bundle -
fhirBundleXmlSerializer![](/images/permalink.svg)
function fhirBundleXmlSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?
Parameters
- data Bundle -
fhirResourceJsonSerializer![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Parameters
- errorResponse error -
getErrorMessage![](/images/permalink.svg)
function getErrorMessage(ClientRequestError requestError) returns string
Extract error messages from 4xx errors.
Parameters
- requestError ClientRequestError - ClientRequestError.
Return Type
- string - Error message.
getFHIRContext![](/images/permalink.svg)
function getFHIRContext(RequestContext httpCtx) returns FHIRContext|FHIRError
Get the FHIR context from the HTTP request context.
Parameters
- httpCtx RequestContext - HTTP request context
Return Type
- FHIRContext|FHIRError - FHIR context or error
getRequestResourceEntity![](/images/permalink.svg)
function getRequestResourceEntity(RequestContext ctx) returns FHIRResourceEntity|FHIRError
Get request resource entity from the FHIR context.
Parameters
- ctx RequestContext - HTTP request context
Return Type
- FHIRResourceEntity|FHIRError - FHIR resource entity or error
getResourceDefinition![](/images/permalink.svg)
function getResourceDefinition(typedesc resourceType) returns ResourceDefinitionRecord|FHIRTypeError
Parameters
- resourceType typedesc -
handleAuditEvent![](/images/permalink.svg)
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![](/images/permalink.svg)
function handleErrorResponse(error errorResponse) returns OperationOutcome
Parameters
- errorResponse error -
handleSmartSecurity![](/images/permalink.svg)
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![](/images/permalink.svg)
function populationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
rangeDataTypeValidationFunction![](/images/permalink.svg)
function rangeDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
ratioDataTypeValidationFunction![](/images/permalink.svg)
function ratioDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
repeatElementDataTypeValidationFunction![](/images/permalink.svg)
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![](/images/permalink.svg)
function substanceAmountDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
triggerDefinitionDataTypeValidationFunction![](/images/permalink.svg)
function triggerDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
urlEncodeFhirSearchParameters![](/images/permalink.svg)
function urlEncodeFhirSearchParameters(map<RequestSearchParameter[] & readonly> & readonly params) returns string|FHIRError
Parameters
- params map<RequestSearchParameter[] & readonly> & readonly -
usageContextDataTypeValidationFunction![](/images/permalink.svg)
function usageContextDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
Classes![](/images/permalink.svg)
health.fhir.r4: FHIRContainerResourceEntity![](/images/permalink.svg)
Class to wrap FHIR resource
unwrap![](/images/permalink.svg)
function unwrap() returns anydata
toXml![](/images/permalink.svg)
function toXml() returns xml|FHIRSerializerError
toJson![](/images/permalink.svg)
function toJson() returns json|FHIRSerializerError
health.fhir.r4: FHIRContainerResponse![](/images/permalink.svg)
Class representing FHIR Container response (Bundle)
getResourceEntity![](/images/permalink.svg)
function getResourceEntity() returns FHIRContainerResourceEntity
health.fhir.r4: FHIRContext![](/images/permalink.svg)
FHIR Context class: used to transfer FHIR request related information down integration flow
setDirection![](/images/permalink.svg)
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![](/images/permalink.svg)
function getDirection() returns MessageDirection
Get context direction : indicate whether the request is in request direction or response direction.
Return Type
- MessageDirection - Message direction
setRawPath![](/images/permalink.svg)
function setRawPath(string path)
Set the raw path of the requested resource.
Parameters
- path string - raw path of the requested resource.
getRawPath![](/images/permalink.svg)
function getRawPath() returns string
Gets the raw path of the requested resource.
Return Type
- string - return the raw path of the requested resource.
isInErrorState![](/images/permalink.svg)
function isInErrorState() returns boolean
Set 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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getErrorCode() returns int
Get error code : error code of the request, if in error.
Return Type
- int - error code of the request, if in error.
getFHIRRequest![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getHTTPRequest() returns HTTPRequest?
Get incoming raw HTTP request information.
Return Type
- HTTPRequest? - Incoming HTTP request
getFHIRResponse![](/images/permalink.svg)
function getFHIRResponse() returns FHIRResponse|FHIRContainerResponse?
Get FHIR response.
Return Type
- FHIRResponse|FHIRContainerResponse? - FHIR response
getInteraction![](/images/permalink.svg)
function getInteraction() returns FHIRInteraction
Get 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![](/images/permalink.svg)
function getResourceType() returns string?
Get target FHIR resource type.
Return Type
- string? - FHIR resource type
getClientAcceptFormat![](/images/permalink.svg)
function getClientAcceptFormat() returns FHIRPayloadFormat
Get client accepted response format.
Return Type
- FHIRPayloadFormat - Client accepted FHIR payload format
getFHIRUser![](/images/permalink.svg)
function getFHIRUser() returns readonly & FHIRUser?
Get FHIR User : End user information available in the JWT.
Return Type
- readonly & FHIRUser? - FHIR Usr information
getRequestSearchParameters![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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.r4: FHIRImplementationGuide![](/images/permalink.svg)
Represents FHIR Implementation Guide holding information and functionalities bound to it
getName![](/images/permalink.svg)
function getName() returns string
getTerminology![](/images/permalink.svg)
function getTerminology() returns Terminology
getProfiles![](/images/permalink.svg)
getSearchParameters![](/images/permalink.svg)
function getSearchParameters() returns map<FHIRSearchParameterDefinition[]>[]
health.fhir.r4: FHIRRegistry![](/images/permalink.svg)
Hold FHIR related information in a particular deployment
addImplementationGuide![](/images/permalink.svg)
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![](/images/permalink.svg)
Get the resource profiles in the registry
Parameters
- resourceType string - The resource type
getResourceSearchParameters![](/images/permalink.svg)
function getResourceSearchParameters(string resourceType) returns SearchParamCollection
Get the resource search parameters in the registry
Parameters
- resourceType string - The resource type
Return Type
- SearchParamCollection - The search parameters in the registry
getResourceSearchParameterByName![](/images/permalink.svg)
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
findProfile![](/images/permalink.svg)
Get the profiles in the registry
Parameters
- url string - The url of the profile
Return Type
- (readonly & Profile)? - The profiles in the registry
findBaseProfile![](/images/permalink.svg)
Get the base profiles in the registry
Parameters
- resourceType string - The resource type
Return Type
- (readonly & Profile)? - The base profile in the registry
isSupportedResource![](/images/permalink.svg)
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
health.fhir.r4: FHIRRequest![](/images/permalink.svg)
Class representing FHIR request
getResourceEntity![](/images/permalink.svg)
function getResourceEntity() returns FHIRResourceEntity?
getSearchParameters![](/images/permalink.svg)
function getSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>
getClientAcceptFormat![](/images/permalink.svg)
function getClientAcceptFormat() returns FHIRPayloadFormat
getResourceType![](/images/permalink.svg)
function getResourceType() returns string?
getInteraction![](/images/permalink.svg)
function getInteraction() returns readonly & FHIRInteraction
health.fhir.r4: FHIRResourceEntity![](/images/permalink.svg)
Class to wrap FHIR resource
unwrap![](/images/permalink.svg)
function unwrap() returns anydata
toXml![](/images/permalink.svg)
function toXml() returns xml|FHIRSerializerError
toJson![](/images/permalink.svg)
function toJson() returns json|FHIRSerializerError
health.fhir.r4: FHIRResponse![](/images/permalink.svg)
Class representing FHIR response
getResourceEntity![](/images/permalink.svg)
function getResourceEntity() returns FHIRResourceEntity
health.fhir.r4: InMemoryTerminologyLoader![](/images/permalink.svg)
An in-memory implementation of a terminology loader
load![](/images/permalink.svg)
function load() returns Terminology|FHIRError
load terminology
Return Type
- Terminology|FHIRError - Terminology populated
health.fhir.r4: TerminologyProcessor![](/images/permalink.svg)
A processor to process terminology data and create relevent data elements
addTerminology![](/images/permalink.svg)
function addTerminology(Terminology terminology)
Parameters
- terminology Terminology -
addCodeSystems![](/images/permalink.svg)
function addCodeSystems(CodeSystem[] codeSystems)
Parameters
- codeSystems CodeSystem[] -
addValueSets![](/images/permalink.svg)
function addValueSets(ValueSet[] valueSets)
Parameters
- valueSets ValueSet[] -
createCodeableConcept![](/images/permalink.svg)
function createCodeableConcept(uri system, code code, CodeSystemFinder? codeSystemFinder) returns CodeableConcept|FHIRError
Create 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![](/images/permalink.svg)
function createCoding(uri system, code code, CodeSystemFinder? codeSystemFinder) returns Coding|FHIRError
Create 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![](/images/permalink.svg)
health.fhir.r4: FHIR_BASE_IG![](/images/permalink.svg)
This is the FHIR base IG name
health.fhir.r4: FHIR_CONTEXT_PROP_NAME![](/images/permalink.svg)
This is the FHIR request context property name
health.fhir.r4: FHIR_MIME_TYPE_JSON![](/images/permalink.svg)
This is the FHIR MIME type FHIR+JSON
health.fhir.r4: FHIR_MIME_TYPE_XML![](/images/permalink.svg)
This is the FHIR MIME type FHIR+XML
health.fhir.r4: FHIR_NAMESPACE![](/images/permalink.svg)
This is the default FHIR XML namespace
health.fhir.r4: FHIR_SEARCH_PARAM_PROFILE![](/images/permalink.svg)
This is the FHIR common search parameter for profile
health.fhir.r4: PROFILE_BASE_BUNDLE![](/images/permalink.svg)
health.fhir.r4: PROFILE_BASE_CODESYSTEM![](/images/permalink.svg)
health.fhir.r4: PROFILE_BASE_OPERATIONOUTCOME![](/images/permalink.svg)
health.fhir.r4: PROFILE_BASE_VALUESET![](/images/permalink.svg)
health.fhir.r4: RESOURCE_NAME_BUNDLE![](/images/permalink.svg)
health.fhir.r4: RESOURCE_NAME_CODESYSTEM![](/images/permalink.svg)
health.fhir.r4: RESOURCE_NAME_OPERATIONOUTCOME![](/images/permalink.svg)
health.fhir.r4: RESOURCE_NAME_VALUESET![](/images/permalink.svg)
Enums![](/images/permalink.svg)
health.fhir.r4: AddressType![](/images/permalink.svg)
Members
health.fhir.r4: AddressUse![](/images/permalink.svg)
Members
health.fhir.r4: AuthzScope![](/images/permalink.svg)
FHIR Authorization scopes.
Members
health.fhir.r4: BundleType![](/images/permalink.svg)
Members
health.fhir.r4: CodeSystemContent![](/images/permalink.svg)
CodeSystemContent enum
Members
health.fhir.r4: CodeSystemFilterOperator![](/images/permalink.svg)
CodeSystemFilterOperator enum
Members
health.fhir.r4: CodeSystemHierarchyMeaning![](/images/permalink.svg)
CodeSystemHierarchyMeaning enum
Members
health.fhir.r4: CodeSystemPropertyType![](/images/permalink.svg)
CodeSystemPropertyType enum
Members
health.fhir.r4: CodeSystemStatus![](/images/permalink.svg)
CodeSystemStatus enum
Members
health.fhir.r4: ContactPointSystem![](/images/permalink.svg)
Members
health.fhir.r4: ContactPointUse![](/images/permalink.svg)
Members
health.fhir.r4: ContributerType![](/images/permalink.svg)
Members
health.fhir.r4: ContributorType![](/images/permalink.svg)
Members
health.fhir.r4: Daycode![](/images/permalink.svg)
Members
health.fhir.r4: DirectionCode![](/images/permalink.svg)
Members
health.fhir.r4: ElementDiscriminatorType![](/images/permalink.svg)
Members
health.fhir.r4: ElementSlicingRules![](/images/permalink.svg)
Members
health.fhir.r4: FHIRErrorTypes![](/images/permalink.svg)
FHIR Error types
Members
health.fhir.r4: FHIRInteractionLevel![](/images/permalink.svg)
FHIR Interaction levels
Members
health.fhir.r4: FHIRInteractionType![](/images/permalink.svg)
FHIR REST Interactions
Members
health.fhir.r4: FHIRPayloadFormat![](/images/permalink.svg)
FHIR Payload formats
Members
health.fhir.r4: FHIRSearchParameterModifier![](/images/permalink.svg)
FHIR search parameter modifiers
Members
health.fhir.r4: FHIRSearchParameterType![](/images/permalink.svg)
FHIR search parameter types
Members
health.fhir.r4: HTTPVerb![](/images/permalink.svg)
Members
health.fhir.r4: HumanNameUse![](/images/permalink.svg)
Members
health.fhir.r4: IdentifierUse![](/images/permalink.svg)
Members
health.fhir.r4: IssueType![](/images/permalink.svg)
Code that describes the type of issue.
Members
health.fhir.r4: MessageDirection![](/images/permalink.svg)
Enum to indicate message flow direction
Members
health.fhir.r4: OperationOutcomeIssueSeverity![](/images/permalink.svg)
OperationOutcomeIssueSeverity enum
Members
health.fhir.r4: ParameterDefinitionUse![](/images/permalink.svg)
Members
health.fhir.r4: Prefix![](/images/permalink.svg)
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
health.fhir.r4: QuantityComparatorCode![](/images/permalink.svg)
Members
health.fhir.r4: RepeatCode![](/images/permalink.svg)
Members
health.fhir.r4: SearchEntryMode![](/images/permalink.svg)
Members
health.fhir.r4: SearchParameterEffectiveLevel![](/images/permalink.svg)
Members
health.fhir.r4: Severity![](/images/permalink.svg)
Level the issue affects the success of the action.
Members
health.fhir.r4: StatusCode![](/images/permalink.svg)
Members
health.fhir.r4: StrengthCode![](/images/permalink.svg)
Members
health.fhir.r4: Timecode![](/images/permalink.svg)
Members
health.fhir.r4: TypeAggregation![](/images/permalink.svg)
Members
health.fhir.r4: TypeVersioning![](/images/permalink.svg)
Members
health.fhir.r4: ValueSetComposeIncludeFilterOp![](/images/permalink.svg)
ValueSetComposeIncludeFilterOp enum
Members
health.fhir.r4: ValueSetStatus![](/images/permalink.svg)
ValueSetStatus enum
Members
Variables![](/images/permalink.svg)
health.fhir.r4: terminologyProcessor![](/images/permalink.svg)
Terminology processor instance
health.fhir.r4: fhirRegistry![](/images/permalink.svg)
FHIR registry instance
health.fhir.r4: COMMON_SEARCH_PARAMETERS![](/images/permalink.svg)
Search Parameters for all resources
health.fhir.r4: CONTROL_SEARCH_PARAMETERS![](/images/permalink.svg)
Search Parameter to control search results
health.fhir.r4: FHIR_VALUE_SETS![](/images/permalink.svg)
health.fhir.r4: FHIR_CODE_SYSTEMS![](/images/permalink.svg)
Annotations![](/images/permalink.svg)
health.fhir.r4: ContainerDefinition![](/images/permalink.svg)
health.fhir.r4: DataTypeDefinition![](/images/permalink.svg)
health.fhir.r4: ResourceDefinition![](/images/permalink.svg)
Records![](/images/permalink.svg)
health.fhir.r4: Address![](/images/permalink.svg)
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.r4: AddressExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueAddress Address -
health.fhir.r4: Age![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- ageValue integer? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: AgeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueAge Age -
health.fhir.r4: Annotation![](/images/permalink.svg)
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
- authorReference Reference? - Individual responsible for the annotation
- authorString string? - Individual responsible for the annotation
- time dateTime? - When the annotation was made
- text markdown - The annotation - text content (as markdown)
health.fhir.r4: AnnotationExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueAnnotation Annotation -
health.fhir.r4: ApiInfo![](/images/permalink.svg)
FHIR API information.
Fields
- resourceType readonly string - FHIR resource type
- searchParameters readonly string[] - supported search parameters
health.fhir.r4: Attachment![](/images/permalink.svg)
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.r4: AttachmentExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueAttachment Attachment -
health.fhir.r4: AuditConfig![](/images/permalink.svg)
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.r4: AuditEventSendingError![](/images/permalink.svg)
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.r4: AuthzConfig![](/images/permalink.svg)
FHIR Authorization service configuration record.
Fields
- authzServiceUrl string - Authorization service URL
- privilegedClaimUrl string - Claim that has privilege to access all patients
health.fhir.r4: AuthzRequest![](/images/permalink.svg)
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.r4: AuthzResponse![](/images/permalink.svg)
FHIR Authorization response record.
Fields
- isAuthorized boolean - Whether the user is authorized to view requested patient data
- scope AuthzScope? - Granted scope
health.fhir.r4: Availability![](/images/permalink.svg)
Fields
- availableTime AvailableTime[]? -
- notAvailableTime NotAvailableTime[]? -
health.fhir.r4: AvailabilityExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueAvailability Availability -
health.fhir.r4: AvailableTime![](/images/permalink.svg)
Fields
- Fields Included from *Element
- id string? -
- extension Extension[]? -
- daysOfWeek string? -
- allDay string? -
- availableStartTime string? -
- availableEndTime string? -
health.fhir.r4: BackboneElement![](/images/permalink.svg)
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.r4: Base64BinaryExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueBase64Binary base64Binary -
health.fhir.r4: BaseBundleMeta![](/images/permalink.svg)
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.r4: BaseCodeSystemMeta![](/images/permalink.svg)
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.r4: BaseOperationOutcomeMeta![](/images/permalink.svg)
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.r4: BaseValueSetMeta![](/images/permalink.svg)
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.r4: BooleanExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueBoolean boolean -
health.fhir.r4: Bundle![](/images/permalink.svg)
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.r4: BundleEntry![](/images/permalink.svg)
Fields
- link BundleLink[]? -
- fullUrl uri? -
- 'resource anydata|FHIRWireFormat? -
- search BundleEntrySearch? -
- request BundleEntryRequest? -
- response BundleEntryResponse? -
health.fhir.r4: BundleEntryModel![](/images/permalink.svg)
Fields
- link BundleLink[]? -
- fullUrl uri? -
- 'resource AnyBaseResource|FHIRWireFormat? -
- search BundleEntrySearch? -
- request BundleEntryRequest? -
- response BundleEntryResponseModel? -
health.fhir.r4: BundleEntryRequest![](/images/permalink.svg)
Fields
- method HTTPVerb -
- url uri -
- ifNoneMatch string? -
- ifModifiedSince instant? -
- ifMatch string? -
- ifNoneExist string? -
health.fhir.r4: BundleEntryResponse![](/images/permalink.svg)
Fields
- status string -
- location uri? -
- etag string? -
- lastModified instant? -
- outcome anydata|FHIRWireFormat? -
health.fhir.r4: BundleEntryResponseModel![](/images/permalink.svg)
Fields
- status string -
- location uri? -
- etag string? -
- lastModified instant? -
- outcome AnyBaseResource|FHIRWireFormat? -
health.fhir.r4: BundleEntrySearch![](/images/permalink.svg)
Fields
- mode SearchEntryMode? -
- score decimal? -
health.fhir.r4: BundleLink![](/images/permalink.svg)
Fields
- relation string -
- url uri -
health.fhir.r4: BundleWireModel![](/images/permalink.svg)
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.r4: CanonicalExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCanonical canonical -
health.fhir.r4: CodeableConcept![](/images/permalink.svg)
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.r4: CodeableConceptExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCodeableConcept CodeableConcept -
health.fhir.r4: CodeableReference![](/images/permalink.svg)
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.r4: CodeableReferenceExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCodeableReference CodeableReference -
health.fhir.r4: CodeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCode code -
health.fhir.r4: CodeSystem![](/images/permalink.svg)
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.r4: CodeSystemConcept![](/images/permalink.svg)
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.r4: CodeSystemConceptDesignation![](/images/permalink.svg)
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.r4: CodeSystemConceptProperty![](/images/permalink.svg)
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.r4: CodeSystemFilter![](/images/permalink.svg)
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.r4: CodeSystemProperty![](/images/permalink.svg)
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.r4: Coding![](/images/permalink.svg)
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.r4: CodingExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCoding Coding -
health.fhir.r4: CommonSearchParameterDefinition![](/images/permalink.svg)
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.r4: CompositeSearchParameter![](/images/permalink.svg)
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...
- value readonly string - Composite search parameter value
health.fhir.r4: ContactDetail![](/images/permalink.svg)
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.r4: ContactDetailExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueContactDetail ContactDetail -
health.fhir.r4: ContactPoint![](/images/permalink.svg)
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.r4: ContactPointExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueContactPoint ContactPoint -
health.fhir.r4: ContainerDefinitionRecord![](/images/permalink.svg)
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.r4: ContainerSerializerCollection![](/images/permalink.svg)
Resource Serializer Collection.
Fields
- 'xml ContainerSerializerFunction - xml serializer
- 'json ContainerSerializerFunction - json serializer
health.fhir.r4: Contributer![](/images/permalink.svg)
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.r4: Contributor![](/images/permalink.svg)
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.r4: Count![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- countValue integer? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: CountExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueCount Count -
health.fhir.r4: DataRequirement![](/images/permalink.svg)
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.r4: DataRequirementExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDataRequirement DataRequirement -
health.fhir.r4: DataTypeDefinitionRecord![](/images/permalink.svg)
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.r4: DataTypeSerializerCollection![](/images/permalink.svg)
Data type serializer collection.
Fields
- 'xml DataTypeSerializerFunction - xml serializer
- 'json DataTypeSerializerFunction - json serializer
health.fhir.r4: DateExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDate date -
health.fhir.r4: DateSearchParameter![](/images/permalink.svg)
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...
- prefix readonly Prefix - Prefix attached with date type search parameter
- value readonly Civil - Value of the received search parameter
health.fhir.r4: DateTimeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDateTime dateTime -
health.fhir.r4: DecimalExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDecimal decimal -
health.fhir.r4: Distance![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- distanceValue decimal? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: DistanceExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDistance Distance -
health.fhir.r4: DomainResource![](/images/permalink.svg)
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.r4: Dosage![](/images/permalink.svg)
How the medication is/was taken or should be taken.
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
- 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.r4: DosageExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDosage Dosage -
health.fhir.r4: Duration![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- durationValue decimal? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: DurationExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueDuration Duration -
health.fhir.r4: Element![](/images/permalink.svg)
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.r4: ElementAnnotationDefinition![](/images/permalink.svg)
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.r4: ElementBase![](/images/permalink.svg)
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.r4: ElementBinding![](/images/permalink.svg)
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.r4: ElementCodeFilter![](/images/permalink.svg)
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.r4: ElementConstraint![](/images/permalink.svg)
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.r4: ElementDateFilter![](/images/permalink.svg)
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.r4: ElementDefinition![](/images/permalink.svg)
Definition of an element in a resource or extension.
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
- 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.r4: ElementDiscriminator![](/images/permalink.svg)
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.r4: ElementDoseAndRate![](/images/permalink.svg)
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.r4: ElementExample![](/images/permalink.svg)
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.r4: ElementMapping![](/images/permalink.svg)
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.r4: ElementRepeat![](/images/permalink.svg)
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.r4: ElementSlicing![](/images/permalink.svg)
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.r4: ElementSort![](/images/permalink.svg)
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.r4: ElementType![](/images/permalink.svg)
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.r4: Expression![](/images/permalink.svg)
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.r4: ExpressionExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueExpression Expression -
health.fhir.r4: ExtendedContactDetail![](/images/permalink.svg)
Fields
- purpose CodeableConcept? -
- name HumanName? -
- telecom ContactPoint? -
- address Address? -
- organization Reference? -
- period Period? -
health.fhir.r4: ExtendedContactDetailExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueExtendedContactDetail ExtendedContactDetail -
health.fhir.r4: ExtensionExtension![](/images/permalink.svg)
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.r4: FHIRCreateInteraction![](/images/permalink.svg)
FHIR Create interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction CREATE(default CREATE) - Interaction type
health.fhir.r4: FHIRErrorDetail![](/images/permalink.svg)
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.r4: FHIRInteraction![](/images/permalink.svg)
FHIR Interaction.
Fields
- interaction FHIRInteractionType - Interaction type
health.fhir.r4: FHIRIssueDetail![](/images/permalink.svg)
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.r4: FHIROperationDefinition![](/images/permalink.svg)
Operation definition representing summary information reqiored 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
health.fhir.r4: FHIRReadInteraction![](/images/permalink.svg)
FHIR Read interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction READ(default READ) - Interaction type
- id string - target resource id
health.fhir.r4: FHIRRequestMimeHeaders![](/images/permalink.svg)
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.r4: FHIRSearchInteraction![](/images/permalink.svg)
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.r4: FHIRSearchParameterDefinition![](/images/permalink.svg)
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.r4: FHIRSecurity![](/images/permalink.svg)
Record to hold information about FHIR related security.
Fields
- securedAPICall readonly 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.r4: FHIRTypedSearchParameter![](/images/permalink.svg)
Base type of decoded/processed search parameter value.
Fields
- modifier readonly FHIRSearchParameterModifier|string? - FHIR Search parameter modifier
health.fhir.r4: FHIRUpdateInteraction![](/images/permalink.svg)
FHIR Update interaction.
Fields
- Fields Included from *FHIRInteraction
- interaction FHIRInteractionType
- anydata...
- interaction UPDATE(default UPDATE) - Interaction type
- id string - Target resource id
health.fhir.r4: FHIRUser![](/images/permalink.svg)
Record to wrap JWT user information.
Fields
- scopes readonly & string[] - The list of scopes the particular user have.
- userID readonly string - Unique user identifier.
health.fhir.r4: HTTPRequest![](/images/permalink.svg)
Record Holding information about the HTTP request.
Fields
health.fhir.r4: HumanName![](/images/permalink.svg)
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.r4: HumanNameExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueHumanName HumanName -
health.fhir.r4: Identifier![](/images/permalink.svg)
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.r4: IdentifierExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueIdentifier Identifier -
health.fhir.r4: IdExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueId id -
health.fhir.r4: IGInfoRecord![](/images/permalink.svg)
Record to hold information about an implementation guide.
Fields
- title readonly string - Name for this implementation guide (human friendly)
- name readonly 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)
health.fhir.r4: Information![](/images/permalink.svg)
Information about a rest feature.
Fields
- description readonly string - Description
- builtin readonly boolean? - Is this feature is available as a built-in feature
- documentation readonly string? - Documentation link
health.fhir.r4: InstantExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueInstant instant -
health.fhir.r4: Integer64Extension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueInteger64 integer64 -
health.fhir.r4: IntegerExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueInteger integer -
health.fhir.r4: InternalAuditEvent![](/images/permalink.svg)
Flattened version of the FHIR AuditEvent (http://hl7.org/fhir/R4/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.r4: JWT![](/images/permalink.svg)
Record holding Decoded JWT content.
Fields
- header readonly & Header - JWT header
- payload readonly & Payload - JWT payload
health.fhir.r4: Mapping![](/images/permalink.svg)
Record type to hold relocation mapping information.
Fields
- sourcePath string - FHIR path to source
- targetPath string - FHIR path to target location
health.fhir.r4: MarkdownExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueMarkdown markdown -
health.fhir.r4: MarketingStatus![](/images/permalink.svg)
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.r4: Meta![](/images/permalink.svg)
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.r4: MetaExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueMeta Meta -
health.fhir.r4: Money![](/images/permalink.svg)
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.r4: MoneyExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueMoney Money -
health.fhir.r4: MoneyQuantity![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- moneyValue decimal? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: Narrative![](/images/permalink.svg)
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.r4: NotAvailableTime![](/images/permalink.svg)
Fields
- Fields Included from *Element
- id string? -
- extension Extension[]? -
- description string? -
- during Period? -
health.fhir.r4: NumberSearchParameter![](/images/permalink.svg)
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...
- prefix readonly Prefix(default eq) - prefix is used to control the nature of the matching
health.fhir.r4: OidExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueOid oid -
health.fhir.r4: OperationConfig![](/images/permalink.svg)
Operation configuration.
Fields
- name readonly string - Name of the operation
- active readonly boolean - Is this operation is activated or deactivated
- 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 infomation about the operation (no processed, just for information)
health.fhir.r4: OperationOutcome![](/images/permalink.svg)
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.r4: OperationOutcomeIssue![](/images/permalink.svg)
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.r4: ParameterDefinition![](/images/permalink.svg)
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.r4: ParameterDefinitionExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueParameterDefinition ParameterDefinition -
health.fhir.r4: Period![](/images/permalink.svg)
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.r4: PeriodExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valuePeriod Period -
health.fhir.r4: Population![](/images/permalink.svg)
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.r4: PositiveIntExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valuePositiveInt positiveInt -
health.fhir.r4: ProcessingMetaInfo![](/images/permalink.svg)
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.r4: ProdCharacteristic![](/images/permalink.svg)
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.r4: ProductShelfLife![](/images/permalink.svg)
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.r4: Profile![](/images/permalink.svg)
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.r4: Quantity![](/images/permalink.svg)
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.r4: QuantityExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueQuantity Quantity -
health.fhir.r4: QuantitySearchParameter![](/images/permalink.svg)
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...
- prefix readonly Prefix - Prefix to the parameter value may be used to control the nature of the matching
- system readonly string - System that defines coded unit form
- code readonly string - Coded form of the unit
health.fhir.r4: Range![](/images/permalink.svg)
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.r4: RangeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueRange Range -
health.fhir.r4: Ratio![](/images/permalink.svg)
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.r4: RatioExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueRatio Ratio -
health.fhir.r4: RatioRange![](/images/permalink.svg)
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.r4: RatioRangeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueRatioRange RatioRange -
health.fhir.r4: Reference![](/images/permalink.svg)
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.r4: ReferenceExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueReference Reference -
health.fhir.r4: ReferenceRange![](/images/permalink.svg)
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.r4: ReferenceSearchParameter![](/images/permalink.svg)
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...
- resourceType readonly string - Referenced resource type
- id readonly string - The logical [id] of a resource using a local reference (i.e. a relative reference)
- url readonly string - Absolute URL - a reference to a resource by its absolute location
health.fhir.r4: RelatedArtifact![](/images/permalink.svg)
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.r4: RelatedArtifactExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueRelatedArtifact RelatedArtifact -
health.fhir.r4: RequestQueryParameter![](/images/permalink.svg)
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.r4: RequestSearchParameter![](/images/permalink.svg)
Record type that holds original incoming values and processed information about the request search parameter.
Fields
- name readonly string - Name of the search parameter (Key of the query parameter)
- value readonly string - Original incoming search parameter value in string format
- 'type readonly FHIRSearchParameterType - Type of search parameter
- typedValue readonly FHIRTypedSearchParameter - Parsed/Decoded search parameter value based on the type of the search parameter
health.fhir.r4: Resource![](/images/permalink.svg)
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)
- Element... - Rest field
health.fhir.r4: ResourceAPIConfigType![](/images/permalink.svg)
API Config representation.
Fields
- resourceType readonly string - FHIR resource type of the API
- profiles readonly string[] - profiles supported by the API
- defaultProfile readonly string - default profile that the FHIR API is supporting
- searchParameters readonly SearchParamConfig[] - Search parameters supported by the FHIR API
- operations readonly OperationConfig[] - Operations supported by the FHIR API
- serverConfig readonly ServerConfig - Serevr configuration
- authzConfig readonly AuthzConfig - Authorization service configuration
- auditConfig readonly AuditConfig? - Audit service configuration
health.fhir.r4: ResourceDefinitionRecord![](/images/permalink.svg)
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.r4: ResourceSerializerCollection![](/images/permalink.svg)
Resource Serializer Collection.
Fields
- 'xml ResourceSerializerFunction - xml serializer
- 'json ResourceSerializerFunction - json serializer
health.fhir.r4: SampledData![](/images/permalink.svg)
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.r4: SampledDataExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueSampledData SampledData -
health.fhir.r4: SearchParamConfig![](/images/permalink.svg)
Search parameter configuration.
Fields
- name readonly string - Name of the search parameter
- active readonly boolean - Is this search parameter is activated or deactivated
- 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.r4: ServerConfig![](/images/permalink.svg)
FHIR Server configurations.
Fields
health.fhir.r4: Signature![](/images/permalink.svg)
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.r4: SignatureExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueSignature Signature -
health.fhir.r4: SimpleData![](/images/permalink.svg)
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.r4: SimpleQuantity![](/images/permalink.svg)
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- value decimal? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: SpecialSearchParameter![](/images/permalink.svg)
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...
- value readonly string - Composite search parameter value
health.fhir.r4: StringExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueString string -
health.fhir.r4: StringSearchParameter![](/images/permalink.svg)
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...
- value readonly string - Value of the received search parameter
health.fhir.r4: SubstanceAmount![](/images/permalink.svg)
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.r4: TerminologyRecord![](/images/permalink.svg)
Holds Terminology information.
Fields
- codeSystems readonly CodeSystem[] - CodeSystems belong to the terminology
- valueSets readonly ValueSet[] - ValueSets belong to the terminology
health.fhir.r4: TimeExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueTime time -
health.fhir.r4: Timing![](/images/permalink.svg)
A timing schedule that specifies an event that may occur multiple times.
Fields
- Fields Included from *Element
- id string? - Unique id for inter-element referencing
- extension Extension[]? - Additional content defined by implementations
- event dateTime[]? - When the event occurs
- repeat ElementRepeat? - When the event is to occur
- code RepeatCode? - BID | TID | QID | AM | PM | QD | QOD | + TimingAbbreviation (Preferred)
health.fhir.r4: TimingExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueTiming Timing -
health.fhir.r4: TokenSearchParameter![](/images/permalink.svg)
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...
- system readonly string - The system property of the Identifier or Coding
- code readonly string - Value of Coding.code or Identifier.value
health.fhir.r4: TriggerDefinition![](/images/permalink.svg)
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.r4: TriggerDefinitionExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueTriggerDefinition TriggerDefinition -
health.fhir.r4: UnsignedIntExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueUnsignedInt unsignedInt -
health.fhir.r4: UriExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueUri uri -
health.fhir.r4: URISearchParameter![](/images/permalink.svg)
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...
- uri readonly uri - URI/URL/URN value
health.fhir.r4: UrlExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueUrl urlType -
health.fhir.r4: UsageContext![](/images/permalink.svg)
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.r4: UsageContextExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueUsageContext UsageContext -
health.fhir.r4: UuidExtension![](/images/permalink.svg)
Fields
- Fields Included from *Element
- url uri -
- valueUuid uuid -
health.fhir.r4: ValueSet![](/images/permalink.svg)
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.r4: ValueSetCompose![](/images/permalink.svg)
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.r4: ValueSetComposeInclude![](/images/permalink.svg)
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.r4: ValueSetComposeIncludeConcept![](/images/permalink.svg)
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.r4: ValueSetComposeIncludeConceptDesignation![](/images/permalink.svg)
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.r4: ValueSetComposeIncludeFilter![](/images/permalink.svg)
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.r4: ValueSetExpansion![](/images/permalink.svg)
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.r4: ValueSetExpansionContains![](/images/permalink.svg)
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.r4: ValueSetExpansionParameter![](/images/permalink.svg)
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.
Errors![](/images/permalink.svg)
health.fhir.r4: FHIRError![](/images/permalink.svg)
Base FHIR error type
health.fhir.r4: FHIRErrorType![](/images/permalink.svg)
FHIR Error type
health.fhir.r4: FHIRParseError![](/images/permalink.svg)
FHIR validation related error
health.fhir.r4: FHIRProcessingError![](/images/permalink.svg)
FHIR processing related issue related error
health.fhir.r4: FHIRSerializerError![](/images/permalink.svg)
FHIR serializer error
health.fhir.r4: FHIRTypeError![](/images/permalink.svg)
FHIR data/resource type related error
health.fhir.r4: FHIRValidationError![](/images/permalink.svg)
FHIR validation related error
Object types![](/images/permalink.svg)
health.fhir.r4: TerminologyLoader![](/images/permalink.svg)
Terminology loader definition
load![](/images/permalink.svg)
function load() returns Terminology|FHIRError
Union types![](/images/permalink.svg)
health.fhir.r4: Extension![](/images/permalink.svg)
Extension
health.fhir.r4: UsageContextValueX![](/images/permalink.svg)
UsageContextValueX
health.fhir.r4: FHIRWireFormat![](/images/permalink.svg)
FHIRWireFormat
FHIR wire content type formats
health.fhir.r4: AnyBaseResource![](/images/permalink.svg)
AnyBaseResource
Aggregated type of all resource type in this IG
Intersection types![](/images/permalink.svg)
health.fhir.r4: Terminology![](/images/permalink.svg)
Terminology
Record type ro represent terminology
health.fhir.r4: ResourceAPIConfig![](/images/permalink.svg)
ResourceAPIConfig
Redefined FHIR read-only FHIR resource API config
Function types![](/images/permalink.svg)
health.fhir.r4: OperationPreProcessor![](/images/permalink.svg)
function(FHIROperationDefinition, FHIRContext) returns (FHIRError?)
OperationPreProcessor
Function type to be implemented to override the operation pre-processing
health.fhir.r4: OperationPostProcessor![](/images/permalink.svg)
function(FHIROperationDefinition, FHIRContext) returns (FHIRError?)
OperationPostProcessor
Function type to be implemented to override the operation post-processing
health.fhir.r4: CodeSystemFinder![](/images/permalink.svg)
function(uri, code) returns (CodeSystem|ValueSet|FHIRError)
CodeSystemFinder
Function definition for code system finder implementations
health.fhir.r4: DataTypeSerializerFunction![](/images/permalink.svg)
function(anydata, ElementAnnotationDefinition) returns ((FHIRWireFormat|FHIRSerializerError)?)
DataTypeSerializerFunction
Function definition for data type serialization
health.fhir.r4: ResourceSerializerFunction![](/images/permalink.svg)
function(anydata) returns ((FHIRWireFormat|FHIRSerializerError)?)
ResourceSerializerFunction
Function definition for FHIR resource serialization
health.fhir.r4: ContainerSerializerFunction![](/images/permalink.svg)
function(Bundle) returns ((FHIRWireFormat|FHIRSerializerError)?)
ContainerSerializerFunction
Function definition for FHIR container resource serialization
health.fhir.r4: DataTypeValidationFunction![](/images/permalink.svg)
function(anydata, ElementAnnotationDefinition) returns (FHIRValidationError?)
DataTypeValidationFunction
Function definition for FHIR data type validation
health.fhir.r4: ResourceTypeValidationFunction![](/images/permalink.svg)
function(anydata) returns (FHIRValidationError?)
ResourceTypeValidationFunction
Function definition for FHIR resource validation
health.fhir.r4: SearchParameterPreProcessor![](/images/permalink.svg)
function(FHIRSearchParameterDefinition, string, RequestQueryParameter) returns (RequestSearchParameter[]|FHIRError)
SearchParameterPreProcessor
Function type to be implemented to override the search parameter pre-processing
health.fhir.r4: SearchParameterPostProcessor![](/images/permalink.svg)
function(FHIRSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)
SearchParameterPostProcessor
Function type to be implemented to override the search parameter post-processing
health.fhir.r4: CommonSearchParameterPreProcessor![](/images/permalink.svg)
function(CommonSearchParameterDefinition, RequestQueryParameter, ResourceAPIConfig) returns (RequestSearchParameter[]|FHIRError)
CommonSearchParameterPreProcessor
common search parameter pre processor function
health.fhir.r4: CommonSearchParameterPostProcessor![](/images/permalink.svg)
function(CommonSearchParameterDefinition, RequestSearchParameter, FHIRContext) returns (FHIRError?)
CommonSearchParameterPostProcessor
common search parameter post processor function
health.fhir.r4: SearchParameterDefaultValueProcessor![](/images/permalink.svg)
function(CommonSearchParameterDefinition, ResourceAPIConfig) returns (anydata|FHIRError?)
SearchParameterDefaultValueProcessor
Integer types![](/images/permalink.svg)
health.fhir.r4: integer![](/images/permalink.svg)
integer
A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal)
- Regex:
[0]|[-+]?[1-9][0-9]*
health.fhir.r4: positiveInt![](/images/permalink.svg)
positiveInt
Any positive integer in the range 1..2,147,483,647
- Regex:
+?[1-9][0-9]*
health.fhir.r4: unsignedInt![](/images/permalink.svg)
unsignedInt
Any non-negative integer in the range 0..2,147,483,647
- Regex:
[0]|([1-9][0-9]*)
health.fhir.r4: integer64![](/images/permalink.svg)
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![](/images/permalink.svg)
health.fhir.r4: SearchParamCollection![](/images/permalink.svg)
SearchParamCollection
Search parameter map (key: parameter name)
Import
import ballerinax/health.fhir.r4;
Metadata
Released date: 5 months ago
Version: 4.3.2
Compatibility
Platform: any
Ballerina version: 2201.8.1
GraalVM compatible: Yes
Pull count
Total: 4900
Current verison: 266
Weekly downloads
Keywords
Healthcare
FHIR
R4
Contributors