health.fhir.r4
Modules
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
1. Parse JSON FHIR resource to FHIR resource model
Sample below is using the Patient resource in health.fhir.r4
package.
import ballerinax/health.fhir.r4; function parseSamplePatient() returns r4:Patient { json patientPayload = { "resourceType": "Patient", "id": "1", "meta": { "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, "active":true, "name":[ { "use":"official", "family":"Chalmers", "given":[ "Peter", "James" ] } ], "gender":"male", "birthDate":"1974-12-25", "managingOrganization":{ "reference":"Organization/1" } }; do { anydata parsedResult = check parse(patientPayload, r4:Patient); r4:Patient patientModel = check parsedResult.ensureType(); log:printInfo(string `Patient name : ${patientModel.name.toString()}`); return patientModel; } on fail error parseError { log:printError(string `Error occurred while parsing : ${parseError.message()}`, parseError); } }
2. Creating FHIR Resource models and serializing to JSON wire formats
import ballerinax/health.fhir.r4; function createSamplePatient() returns json { r4:Patient patient = { meta: { lastUpdated: time:utcToString(time:utcNow()), profile: [r4:PROFILE_BASE_PATIENT] }, active: true, name: [{ family: "Doe", given: ["Jhon"], use: r4:official, prefix: ["Mr"] }], address: [{ line: ["652 S. Lantern Dr."], city: "New York", country: "United States", postalCode: "10022", 'type: r4:physical, use: r4:home }] }; FHIRResourceEntity fhirEntity = new(patient); // Serialize FHIR resource record to Json payload json|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
annotationDataTypeValidationFunction
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
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
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
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
createFhirBundle
function createFhirBundle(BundleType t, DomainResource[] resources) returns Bundle
Create a FHIR Bundle.
Return Type
- Bundle - Return a FHIR Bundle.
createFHIRError
function createFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? 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 "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? (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
function createInternalFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? 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 "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? (default ()) - (optional) type of the error
Return Type
- FHIRError - Created FHIRError error
createParserErrorFrom
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
dataFilterDataTypeValidationFunction
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
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
function decodeFhirSearchParameters(string urlEncodedParams) returns map<RequestSearchParameter[] & readonly>|FHIRError
Parameters
- urlEncodedParams string -
dosageDataTypeValidationFunction
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
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
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
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
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
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
fhirBundleJsonSerializer
function fhirBundleJsonSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?
Parameters
- data Bundle -
fhirBundleXmlSerializer
function fhirBundleXmlSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?
Parameters
- data Bundle -
fhirResourceJsonSerializer
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
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
Parameters
- errorResponse error -
getErrorMessage
function getErrorMessage(ClientRequestError requestError) returns string
Extract error messages from 4xx errors.
Parameters
- requestError ClientRequestError - ClientRequestError.
Return Type
- string - Error message.
getFHIRContext
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
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
handleErrorResponse
function handleErrorResponse(error errorResponse) returns OperationOutcome
Parameters
- errorResponse error -
parse
function parse(json|xml|string payload, typedesc<anydata>? targetFHIRModelType, string? targetProfile) returns anydata|FHIRParseError
Function to parse FHIR Payload into FHIR Resource model. Note : When using inside FHIR templates, use ballerinax/health.fhir.r4.parser module instead of this.
Parameters
- targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to parse. Derived from payload if not given
- targetProfile string? (default ()) - (Optional) target profile to parse. Derived from payload if not given
Return Type
- anydata|FHIRParseError - returns FHIR model (Need to cast to relevant type by the caller). FHIRParseError if error ocurred
populationDataTypeValidationFunction
function populationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
rangeDataTypeValidationFunction
function rangeDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
ratioDataTypeValidationFunction
function ratioDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
repeatElementDataTypeValidationFunction
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
function substanceAmountDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
triggerDefinitionDataTypeValidationFunction
function triggerDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
urlEncodeFhirSearchParameters
function urlEncodeFhirSearchParameters(map<RequestSearchParameter[] & readonly> & readonly params) returns string|FHIRError
Parameters
- params map<RequestSearchParameter[] & readonly> & readonly -
usageContextDataTypeValidationFunction
function usageContextDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?
validate
function validate(json|anydata data, typedesc<anydata>? targetFHIRModelType) returns FHIRValidationError?
This method will validate FHIR resource. Validation consist of Structure, cardinality, Value domain, Profile, json.
Parameters
- data json|anydata - FHIR resource (can be in json or anydata)
- targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to validate. Derived from payload if not given
Return Type
- FHIRValidationError? - If the validation fails, return validation error
Classes
health.fhir.r4: FHIRContainerResourceEntity
Class to wrap FHIR resource
unwrap
function unwrap() returns anydata
toXml
function toXml() returns xml|FHIRSerializerError
toJson
function toJson() returns json|FHIRSerializerError
health.fhir.r4: FHIRContainerResponse
Class representing FHIR Container response (Bundle)
getResourceEntity
function getResourceEntity() returns FHIRContainerResourceEntity
health.fhir.r4: FHIRContext
FHIR Context class: used to transfer FHIR request related information down integration flow
getDirection
function getDirection() returns MessageDirection
Get context direction : indicate whether the request is in request direction or response direction.
Return Type
- MessageDirection - Message direction
isInErrorState
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
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
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
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
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
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
function getHTTPRequest() returns HTTPRequest?
Get incoming raw HTTP request information.
Return Type
- HTTPRequest? - Incoming HTTP request
getFHIRResponse
function getFHIRResponse() returns FHIRResponse|FHIRContainerResponse?
Get FHIR response.
Return Type
- FHIRResponse|FHIRContainerResponse? - FHIR response
getInteraction
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
function getResourceType() returns string?
Get target FHIR resource type.
Return Type
- string? - FHIR resource type
getClientAcceptFormat
function getClientAcceptFormat() returns FHIRPayloadFormat
Get client accepted response format.
Return Type
- FHIRPayloadFormat - Client accepted FHIR payload format
getFHIRUser
function getFHIRUser() returns readonly & FHIRUser?
Get FHIR User : End user information available in the JWT.
Return Type
- readonly & FHIRUser? - FHIR Usr information
getRequestSearchParameters
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
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
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
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
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
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
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
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
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
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
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
Represents FHIR Implementation Guide holding information and functionalities bound to it
getName
function getName() returns string
getTerminology
function getTerminology() returns Terminology
getProfiles
getSearchParameters
function getSearchParameters() returns map<FHIRSearchParameterDefinition[]>[]
health.fhir.r4: FHIRPreprocessor
FHIR Pre-processor implementation.
Constructor
Initialize the FHIR pre-processor
init (ResourceAPIConfig apiConfig)
- apiConfig ResourceAPIConfig - The API configuration
processRead
function processRead(string fhirResourceType, string id, Request httpRequest, RequestContext httpCtx) returns FHIRError?
Process the FHIR Read interaction.
Parameters
- fhirResourceType string - The FHIR resource type
- id string - The FHIR resource id
- httpRequest Request - The HTTP request
- httpCtx RequestContext - The HTTP request context
Return Type
- FHIRError? - The next service or an error
processSearch
function processSearch(string fhirResourceType, Request httpRequest, RequestContext httpCtx) returns FHIRError?
Process the FHIR Search interaction.
Parameters
- fhirResourceType string - The FHIR resource type
- httpRequest Request - The HTTP request
- httpCtx RequestContext - The HTTP request context
Return Type
- FHIRError? - The next service or an error
processCreate
function processCreate(string resourceType, json|xml payload, Request httpRequest, RequestContext httpCtx) returns FHIRError?
Process the FHIR Create interaction.
Parameters
- resourceType string - The FHIR resource type
- payload json|xml - The payload
- httpRequest Request - The HTTP request
- httpCtx RequestContext - The HTTP request context
Return Type
- FHIRError? - The next service or an error
health.fhir.r4: FHIRRegistry
Hold FHIR related information in a particular deployment
addImplementationGuide
function addImplementationGuide(FHIRImplementationGuide ig) returns FHIRError?
Add an implementation guide to the registry
Parameters
- ig FHIRImplementationGuide - The implementation guide to be added
Return Type
- FHIRError? - An error if the implementation guide is invalid or an error occurred while adding the implementation guide
getResourceProfiles
Get the resource profiles in the registry
Parameters
- resourceType string - The resource type
getResourceSearchParameters
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
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
Get the profiles in the registry
Parameters
- url string - The url of the profile
Return Type
- (readonly & Profile)? - The profiles in the registry
findBaseProfile
Get the base profiles in the registry
Parameters
- resourceType string - The resource type
Return Type
- (readonly & Profile)? - The base profile in the registry
isSupportedResource
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
Class representing FHIR request
getResourceEntity
function getResourceEntity() returns FHIRResourceEntity?
getSearchParameters
function getSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>
getClientAcceptFormat
function getClientAcceptFormat() returns FHIRPayloadFormat
getResourceType
function getResourceType() returns string?
getInteraction
function getInteraction() returns readonly & FHIRInteraction
health.fhir.r4: FHIRResourceEntity
Class to wrap FHIR resource
unwrap
function unwrap() returns anydata
toXml
function toXml() returns xml|FHIRSerializerError
toJson
function toJson() returns json|FHIRSerializerError
health.fhir.r4: FHIRResponse
Class representing FHIR response
getResourceEntity
function getResourceEntity() returns FHIRResourceEntity
health.fhir.r4: FHIRResponseErrorInterceptor
Response error interceptor to handle errors thrown by fhir preproccessors
interceptResponseError
function interceptResponseError(error err) returns NotFound|BadRequest|UnsupportedMediaType|NotAcceptable|Unauthorized|NotImplemented|InternalServerError
Parameters
- err error -
health.fhir.r4: FHIRResponseInterceptor
Response error interceptor to post-process FHIR responses
interceptResponse
function interceptResponse(RequestContext ctx, Response res) returns NextService|FHIRError?
health.fhir.r4: InMemoryTerminologyLoader
An in-memory implementation of a terminology loader
load
function load() returns Terminology|FHIRError
load terminology
Return Type
- Terminology|FHIRError - Terminology populated
health.fhir.r4: TerminologyProcessor
A processor to process terminology data and create relevent data elements
addTerminology
function addTerminology(Terminology terminology)
Parameters
- terminology Terminology -
addCodeSystems
function addCodeSystems(CodeSystem[] codeSystems)
Parameters
- codeSystems CodeSystem[] -
addValueSets
function addValueSets(ValueSet[] valueSets)
Parameters
- valueSets ValueSet[] -
createCodeableConcept
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
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
health.fhir.r4: FHIR_BASE_IG
This is the FHIR base IG name
health.fhir.r4: FHIR_CONTEXT_PROP_NAME
This is the FHIR request context property name
health.fhir.r4: FHIR_MIME_TYPE_JSON
This is the FHIR MIME type FHIR+JSON
health.fhir.r4: FHIR_MIME_TYPE_XML
This is the FHIR MIME type FHIR+XML
health.fhir.r4: FHIR_NAMESPACE
This is the default FHIR XML namespace
health.fhir.r4: FHIR_SEARCH_PARAM_PROFILE
This is the FHIR common search parameter for profile
health.fhir.r4: PROFILE_BASE_ACCOUNT
health.fhir.r4: PROFILE_BASE_ACTIVITYDEFINITION
health.fhir.r4: PROFILE_BASE_ADVERSEEVENT
health.fhir.r4: PROFILE_BASE_ALLERGYINTOLERANCE
health.fhir.r4: PROFILE_BASE_APPOINTMENT
health.fhir.r4: PROFILE_BASE_APPOINTMENTRESPONSE
health.fhir.r4: PROFILE_BASE_AUDITEVENT
health.fhir.r4: PROFILE_BASE_BASIC
health.fhir.r4: PROFILE_BASE_BINARY
health.fhir.r4: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT
health.fhir.r4: PROFILE_BASE_BODYSTRUCTURE
health.fhir.r4: PROFILE_BASE_BUNDLE
health.fhir.r4: PROFILE_BASE_CAPABILITYSTATEMENT
health.fhir.r4: PROFILE_BASE_CAREPLAN
health.fhir.r4: PROFILE_BASE_CARETEAM
health.fhir.r4: PROFILE_BASE_CATALOGENTRY
health.fhir.r4: PROFILE_BASE_CHARGEITEM
health.fhir.r4: PROFILE_BASE_CHARGEITEMDEFINITION
health.fhir.r4: PROFILE_BASE_CLAIM
health.fhir.r4: PROFILE_BASE_CLAIMRESPONSE
health.fhir.r4: PROFILE_BASE_CLINICALIMPRESSION
health.fhir.r4: PROFILE_BASE_CODESYSTEM
health.fhir.r4: PROFILE_BASE_COMMUNICATION
health.fhir.r4: PROFILE_BASE_COMMUNICATIONREQUEST
health.fhir.r4: PROFILE_BASE_COMPARTMENTDEFINITION
health.fhir.r4: PROFILE_BASE_COMPOSITION
health.fhir.r4: PROFILE_BASE_CONCEPTMAP
health.fhir.r4: PROFILE_BASE_CONDITION
health.fhir.r4: PROFILE_BASE_CONSENT
health.fhir.r4: PROFILE_BASE_CONTRACT
health.fhir.r4: PROFILE_BASE_COVERAGE
health.fhir.r4: PROFILE_BASE_COVERAGEELIGIBILITYREQUEST
health.fhir.r4: PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE
health.fhir.r4: PROFILE_BASE_DETECTEDISSUE
health.fhir.r4: PROFILE_BASE_DEVICE
health.fhir.r4: PROFILE_BASE_DEVICEDEFINITION
health.fhir.r4: PROFILE_BASE_DEVICEMETRIC
health.fhir.r4: PROFILE_BASE_DEVICEREQUEST
health.fhir.r4: PROFILE_BASE_DEVICEUSESTATEMENT
health.fhir.r4: PROFILE_BASE_DIAGNOSTICREPORT
health.fhir.r4: PROFILE_BASE_DOCUMENTMANIFEST
health.fhir.r4: PROFILE_BASE_DOCUMENTREFERENCE
health.fhir.r4: PROFILE_BASE_EFFECTEVIDENCESYNTHESIS
health.fhir.r4: PROFILE_BASE_ENCOUNTER
health.fhir.r4: PROFILE_BASE_ENDPOINT
health.fhir.r4: PROFILE_BASE_ENROLLMENTREQUEST
health.fhir.r4: PROFILE_BASE_ENROLLMENTRESPONSE
health.fhir.r4: PROFILE_BASE_EPISODEOFCARE
health.fhir.r4: PROFILE_BASE_EVENTDEFINITION
health.fhir.r4: PROFILE_BASE_EVIDENCE
health.fhir.r4: PROFILE_BASE_EVIDENCEVARIABLE
health.fhir.r4: PROFILE_BASE_EXAMPLESCENARIO
health.fhir.r4: PROFILE_BASE_EXPLANATIONOFBENEFIT
health.fhir.r4: PROFILE_BASE_FAMILYMEMBERHISTORY
health.fhir.r4: PROFILE_BASE_FLAG
health.fhir.r4: PROFILE_BASE_GOAL
health.fhir.r4: PROFILE_BASE_GRAPHDEFINITION
health.fhir.r4: PROFILE_BASE_GROUP
health.fhir.r4: PROFILE_BASE_GUIDANCERESPONSE
health.fhir.r4: PROFILE_BASE_HEALTHCARESERVICE
health.fhir.r4: PROFILE_BASE_IMAGINGSTUDY
health.fhir.r4: PROFILE_BASE_IMMUNIZATION
health.fhir.r4: PROFILE_BASE_IMMUNIZATIONEVALUATION
health.fhir.r4: PROFILE_BASE_IMMUNIZATIONRECOMMENDATION
health.fhir.r4: PROFILE_BASE_IMPLEMENTATIONGUIDE
health.fhir.r4: PROFILE_BASE_INSURANCEPLAN
health.fhir.r4: PROFILE_BASE_INVOICE
health.fhir.r4: PROFILE_BASE_LIBRARY
health.fhir.r4: PROFILE_BASE_LINKAGE
health.fhir.r4: PROFILE_BASE_LIST
health.fhir.r4: PROFILE_BASE_LOCATION
health.fhir.r4: PROFILE_BASE_MEASURE
health.fhir.r4: PROFILE_BASE_MEASUREREPORT
health.fhir.r4: PROFILE_BASE_MEDIA
health.fhir.r4: PROFILE_BASE_MEDICATION
health.fhir.r4: PROFILE_BASE_MEDICATIONADMINISTRATION
health.fhir.r4: PROFILE_BASE_MEDICATIONDISPENSE
health.fhir.r4: PROFILE_BASE_MEDICATIONKNOWLEDGE
health.fhir.r4: PROFILE_BASE_MEDICATIONREQUEST
health.fhir.r4: PROFILE_BASE_MEDICATIONSTATEMENT
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCT
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTAUTHORIZATION
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTCONTRAINDICATION
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINDICATION
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINGREDIENT
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINTERACTION
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTMANUFACTURED
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTPACKAGED
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTPHARMACEUTICAL
health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTUNDESIRABLEEFFECT
health.fhir.r4: PROFILE_BASE_MESSAGEDEFINITION
health.fhir.r4: PROFILE_BASE_MESSAGEHEADER
health.fhir.r4: PROFILE_BASE_MOLECULARSEQUENCE
health.fhir.r4: PROFILE_BASE_NAMINGSYSTEM
health.fhir.r4: PROFILE_BASE_NUTRITIONORDER
health.fhir.r4: PROFILE_BASE_OBSERVATION
health.fhir.r4: PROFILE_BASE_OBSERVATION_VITALSIGNS
health.fhir.r4: PROFILE_BASE_OBSERVATIONDEFINITION
health.fhir.r4: PROFILE_BASE_OPERATIONDEFINITION
health.fhir.r4: PROFILE_BASE_OPERATIONOUTCOME
health.fhir.r4: PROFILE_BASE_ORGANIZATION
health.fhir.r4: PROFILE_BASE_ORGANIZATIONAFFILIATION
health.fhir.r4: PROFILE_BASE_PARAMETERS
health.fhir.r4: PROFILE_BASE_PATIENT
health.fhir.r4: PROFILE_BASE_PAYMENTNOTICE
health.fhir.r4: PROFILE_BASE_PAYMENTRECONCILIATION
health.fhir.r4: PROFILE_BASE_PERSON
health.fhir.r4: PROFILE_BASE_PLANDEFINITION
health.fhir.r4: PROFILE_BASE_PRACTITIONER
health.fhir.r4: PROFILE_BASE_PRACTITIONERROLE
health.fhir.r4: PROFILE_BASE_PROCEDURE
health.fhir.r4: PROFILE_BASE_PROVENANCE
health.fhir.r4: PROFILE_BASE_QUESTIONNAIRE
health.fhir.r4: PROFILE_BASE_QUESTIONNAIRERESPONSE
health.fhir.r4: PROFILE_BASE_RELATEDPERSON
health.fhir.r4: PROFILE_BASE_REQUESTGROUP
health.fhir.r4: PROFILE_BASE_RESEARCHDEFINITION
health.fhir.r4: PROFILE_BASE_RESEARCHELEMENTDEFINITION
health.fhir.r4: PROFILE_BASE_RESEARCHSTUDY
health.fhir.r4: PROFILE_BASE_RESEARCHSUBJECT
health.fhir.r4: PROFILE_BASE_RISKASSESSMENT
health.fhir.r4: PROFILE_BASE_RISKEVIDENCESYNTHESIS
health.fhir.r4: PROFILE_BASE_SCHEDULE
health.fhir.r4: PROFILE_BASE_SEARCHPARAMETER
health.fhir.r4: PROFILE_BASE_SERVICEREQUEST
health.fhir.r4: PROFILE_BASE_SLOT
health.fhir.r4: PROFILE_BASE_SPECIMEN
health.fhir.r4: PROFILE_BASE_SPECIMENDEFINITION
health.fhir.r4: PROFILE_BASE_STRUCTUREDEFINITION
health.fhir.r4: PROFILE_BASE_STRUCTUREMAP
health.fhir.r4: PROFILE_BASE_SUBSCRIPTION
health.fhir.r4: PROFILE_BASE_SUBSTANCE
health.fhir.r4: PROFILE_BASE_SUBSTANCENUCLEICACID
health.fhir.r4: PROFILE_BASE_SUBSTANCEPOLYMER
health.fhir.r4: PROFILE_BASE_SUBSTANCEPROTEIN
health.fhir.r4: PROFILE_BASE_SUBSTANCEREFERENCEINFORMATION
health.fhir.r4: PROFILE_BASE_SUBSTANCESOURCEMATERIAL
health.fhir.r4: PROFILE_BASE_SUBSTANCESPECIFICATION
health.fhir.r4: PROFILE_BASE_SUPPLYDELIVERY
health.fhir.r4: PROFILE_BASE_SUPPLYREQUEST
health.fhir.r4: PROFILE_BASE_TASK
health.fhir.r4: PROFILE_BASE_TERMINOLOGYCAPABILITIES
health.fhir.r4: PROFILE_BASE_TESTREPORT
health.fhir.r4: PROFILE_BASE_TESTSCRIPT
health.fhir.r4: PROFILE_BASE_VALUESET
health.fhir.r4: PROFILE_BASE_VERIFICATIONRESULT
health.fhir.r4: PROFILE_BASE_VISIONPRESCRIPTION
health.fhir.r4: RESOURCE_NAME_ACCOUNT
health.fhir.r4: RESOURCE_NAME_ACTIVITYDEFINITION
health.fhir.r4: RESOURCE_NAME_ADVERSEEVENT
health.fhir.r4: RESOURCE_NAME_ALLERGYINTOLERANCE
health.fhir.r4: RESOURCE_NAME_APPOINTMENT
health.fhir.r4: RESOURCE_NAME_APPOINTMENTRESPONSE
health.fhir.r4: RESOURCE_NAME_AUDITEVENT
health.fhir.r4: RESOURCE_NAME_BASIC
health.fhir.r4: RESOURCE_NAME_BINARY
health.fhir.r4: RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT
health.fhir.r4: RESOURCE_NAME_BODYSTRUCTURE
health.fhir.r4: RESOURCE_NAME_BUNDLE
health.fhir.r4: RESOURCE_NAME_CAPABILITYSTATEMENT
health.fhir.r4: RESOURCE_NAME_CAREPLAN
health.fhir.r4: RESOURCE_NAME_CARETEAM
health.fhir.r4: RESOURCE_NAME_CATALOGENTRY
health.fhir.r4: RESOURCE_NAME_CHARGEITEM
health.fhir.r4: RESOURCE_NAME_CHARGEITEMDEFINITION
health.fhir.r4: RESOURCE_NAME_CLAIM
health.fhir.r4: RESOURCE_NAME_CLAIMRESPONSE
health.fhir.r4: RESOURCE_NAME_CLINICALIMPRESSION
health.fhir.r4: RESOURCE_NAME_CODESYSTEM
health.fhir.r4: RESOURCE_NAME_COMMUNICATION
health.fhir.r4: RESOURCE_NAME_COMMUNICATIONREQUEST
health.fhir.r4: RESOURCE_NAME_COMPARTMENTDEFINITION
health.fhir.r4: RESOURCE_NAME_COMPOSITION
health.fhir.r4: RESOURCE_NAME_CONCEPTMAP
health.fhir.r4: RESOURCE_NAME_CONDITION
health.fhir.r4: RESOURCE_NAME_CONSENT
health.fhir.r4: RESOURCE_NAME_CONTRACT
health.fhir.r4: RESOURCE_NAME_COVERAGE
health.fhir.r4: RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST
health.fhir.r4: RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE
health.fhir.r4: RESOURCE_NAME_DETECTEDISSUE
health.fhir.r4: RESOURCE_NAME_DEVICE
health.fhir.r4: RESOURCE_NAME_DEVICEDEFINITION
health.fhir.r4: RESOURCE_NAME_DEVICEMETRIC
health.fhir.r4: RESOURCE_NAME_DEVICEREQUEST
health.fhir.r4: RESOURCE_NAME_DEVICEUSESTATEMENT
health.fhir.r4: RESOURCE_NAME_DIAGNOSTICREPORT
health.fhir.r4: RESOURCE_NAME_DOCUMENTMANIFEST
health.fhir.r4: RESOURCE_NAME_DOCUMENTREFERENCE
health.fhir.r4: RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS
health.fhir.r4: RESOURCE_NAME_ENCOUNTER
health.fhir.r4: RESOURCE_NAME_ENDPOINT
health.fhir.r4: RESOURCE_NAME_ENROLLMENTREQUEST
health.fhir.r4: RESOURCE_NAME_ENROLLMENTRESPONSE
health.fhir.r4: RESOURCE_NAME_EPISODEOFCARE
health.fhir.r4: RESOURCE_NAME_EVENTDEFINITION
health.fhir.r4: RESOURCE_NAME_EVIDENCE
health.fhir.r4: RESOURCE_NAME_EVIDENCEVARIABLE
health.fhir.r4: RESOURCE_NAME_EXAMPLESCENARIO
health.fhir.r4: RESOURCE_NAME_EXPLANATIONOFBENEFIT
health.fhir.r4: RESOURCE_NAME_FAMILYMEMBERHISTORY
health.fhir.r4: RESOURCE_NAME_FLAG
health.fhir.r4: RESOURCE_NAME_GOAL
health.fhir.r4: RESOURCE_NAME_GRAPHDEFINITION
health.fhir.r4: RESOURCE_NAME_GROUP
health.fhir.r4: RESOURCE_NAME_GUIDANCERESPONSE
health.fhir.r4: RESOURCE_NAME_HEALTHCARESERVICE
health.fhir.r4: RESOURCE_NAME_IMAGINGSTUDY
health.fhir.r4: RESOURCE_NAME_IMMUNIZATION
health.fhir.r4: RESOURCE_NAME_IMMUNIZATIONEVALUATION
health.fhir.r4: RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION
health.fhir.r4: RESOURCE_NAME_IMPLEMENTATIONGUIDE
health.fhir.r4: RESOURCE_NAME_INSURANCEPLAN
health.fhir.r4: RESOURCE_NAME_INVOICE
health.fhir.r4: RESOURCE_NAME_LIBRARY
health.fhir.r4: RESOURCE_NAME_LINKAGE
health.fhir.r4: RESOURCE_NAME_LIST
health.fhir.r4: RESOURCE_NAME_LOCATION
health.fhir.r4: RESOURCE_NAME_MEASURE
health.fhir.r4: RESOURCE_NAME_MEASUREREPORT
health.fhir.r4: RESOURCE_NAME_MEDIA
health.fhir.r4: RESOURCE_NAME_MEDICATION
health.fhir.r4: RESOURCE_NAME_MEDICATIONADMINISTRATION
health.fhir.r4: RESOURCE_NAME_MEDICATIONDISPENSE
health.fhir.r4: RESOURCE_NAME_MEDICATIONKNOWLEDGE
health.fhir.r4: RESOURCE_NAME_MEDICATIONREQUEST
health.fhir.r4: RESOURCE_NAME_MEDICATIONSTATEMENT
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCT
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINDICATION
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINTERACTION
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTPACKAGED
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL
health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT
health.fhir.r4: RESOURCE_NAME_MESSAGEDEFINITION
health.fhir.r4: RESOURCE_NAME_MESSAGEHEADER
health.fhir.r4: RESOURCE_NAME_MOLECULARSEQUENCE
health.fhir.r4: RESOURCE_NAME_NAMINGSYSTEM
health.fhir.r4: RESOURCE_NAME_NUTRITIONORDER
health.fhir.r4: RESOURCE_NAME_OBSERVATION
health.fhir.r4: RESOURCE_NAME_OBSERVATION_VITALSIGNS
health.fhir.r4: RESOURCE_NAME_OBSERVATIONDEFINITION
health.fhir.r4: RESOURCE_NAME_OPERATIONDEFINITION
health.fhir.r4: RESOURCE_NAME_OPERATIONOUTCOME
health.fhir.r4: RESOURCE_NAME_ORGANIZATION
health.fhir.r4: RESOURCE_NAME_ORGANIZATIONAFFILIATION
health.fhir.r4: RESOURCE_NAME_PARAMETERS
health.fhir.r4: RESOURCE_NAME_PATIENT
health.fhir.r4: RESOURCE_NAME_PAYMENTNOTICE
health.fhir.r4: RESOURCE_NAME_PAYMENTRECONCILIATION
health.fhir.r4: RESOURCE_NAME_PERSON
health.fhir.r4: RESOURCE_NAME_PLANDEFINITION
health.fhir.r4: RESOURCE_NAME_PRACTITIONER
health.fhir.r4: RESOURCE_NAME_PRACTITIONERROLE
health.fhir.r4: RESOURCE_NAME_PROCEDURE
health.fhir.r4: RESOURCE_NAME_PROVENANCE
health.fhir.r4: RESOURCE_NAME_QUESTIONNAIRE
health.fhir.r4: RESOURCE_NAME_QUESTIONNAIRERESPONSE
health.fhir.r4: RESOURCE_NAME_RELATEDPERSON
health.fhir.r4: RESOURCE_NAME_REQUESTGROUP
health.fhir.r4: RESOURCE_NAME_RESEARCHDEFINITION
health.fhir.r4: RESOURCE_NAME_RESEARCHELEMENTDEFINITION
health.fhir.r4: RESOURCE_NAME_RESEARCHSTUDY
health.fhir.r4: RESOURCE_NAME_RESEARCHSUBJECT
health.fhir.r4: RESOURCE_NAME_RISKASSESSMENT
health.fhir.r4: RESOURCE_NAME_RISKEVIDENCESYNTHESIS
health.fhir.r4: RESOURCE_NAME_SCHEDULE
health.fhir.r4: RESOURCE_NAME_SEARCHPARAMETER
health.fhir.r4: RESOURCE_NAME_SERVICEREQUEST
health.fhir.r4: RESOURCE_NAME_SLOT
health.fhir.r4: RESOURCE_NAME_SPECIMEN
health.fhir.r4: RESOURCE_NAME_SPECIMENDEFINITION
health.fhir.r4: RESOURCE_NAME_STRUCTUREDEFINITION
health.fhir.r4: RESOURCE_NAME_STRUCTUREMAP
health.fhir.r4: RESOURCE_NAME_SUBSCRIPTION
health.fhir.r4: RESOURCE_NAME_SUBSTANCE
health.fhir.r4: RESOURCE_NAME_SUBSTANCENUCLEICACID
health.fhir.r4: RESOURCE_NAME_SUBSTANCEPOLYMER
health.fhir.r4: RESOURCE_NAME_SUBSTANCEPROTEIN
health.fhir.r4: RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION
health.fhir.r4: RESOURCE_NAME_SUBSTANCESOURCEMATERIAL
health.fhir.r4: RESOURCE_NAME_SUBSTANCESPECIFICATION
health.fhir.r4: RESOURCE_NAME_SUPPLYDELIVERY
health.fhir.r4: RESOURCE_NAME_SUPPLYREQUEST
health.fhir.r4: RESOURCE_NAME_TASK
health.fhir.r4: RESOURCE_NAME_TERMINOLOGYCAPABILITIES
health.fhir.r4: RESOURCE_NAME_TESTREPORT
health.fhir.r4: RESOURCE_NAME_TESTSCRIPT
health.fhir.r4: RESOURCE_NAME_VALUESET
health.fhir.r4: RESOURCE_NAME_VERIFICATIONRESULT
health.fhir.r4: RESOURCE_NAME_VISIONPRESCRIPTION
Enums
health.fhir.r4: AccountStatus
AccountStatus enum
Members
health.fhir.r4: ActivityDefinitionIntent
ActivityDefinitionIntent enum
Members
health.fhir.r4: ActivityDefinitionParticipantType
ActivityDefinitionParticipantType enum
Members
health.fhir.r4: ActivityDefinitionPriority
ActivityDefinitionPriority enum
Members
health.fhir.r4: ActivityDefinitionStatus
ActivityDefinitionStatus enum
Members
health.fhir.r4: AddressType
Members
health.fhir.r4: AddressUse
Members
health.fhir.r4: AdverseEventActuality
AdverseEventActuality enum
Members
health.fhir.r4: AllergyIntoleranceCategory
AllergyIntoleranceCategory enum
Members
health.fhir.r4: AllergyIntoleranceCriticality
AllergyIntoleranceCriticality enum
Members
health.fhir.r4: AllergyIntoleranceReactionSeverity
AllergyIntoleranceReactionSeverity enum
Members
health.fhir.r4: AllergyIntoleranceType
AllergyIntoleranceType enum
Members
health.fhir.r4: AppointmentParticipantRequired
AppointmentParticipantRequired enum
Members
health.fhir.r4: AppointmentParticipantStatus
AppointmentParticipantStatus enum
Members
health.fhir.r4: AppointmentResponseParticipantStatus
AppointmentResponseParticipantStatus enum
Members
health.fhir.r4: AppointmentStatus
AppointmentStatus enum
Members
health.fhir.r4: BiologicallyDerivedProductProductCategory
BiologicallyDerivedProductProductCategory enum
Members
health.fhir.r4: BiologicallyDerivedProductStatus
BiologicallyDerivedProductStatus enum
Members
health.fhir.r4: BiologicallyDerivedProductStorageScale
BiologicallyDerivedProductStorageScale enum
Members
health.fhir.r4: BundleType
Members
health.fhir.r4: CapabilityStatementDocumentMode
CapabilityStatementDocumentMode enum
Members
health.fhir.r4: CapabilityStatementFormat
CapabilityStatementFormat enum
Members
health.fhir.r4: CapabilityStatementKind
CapabilityStatementKind enum
Members
health.fhir.r4: CapabilityStatementMessagingSupportedMessageMode
CapabilityStatementMessagingSupportedMessageMode enum
Members
health.fhir.r4: CapabilityStatementRestInteractionCode
CapabilityStatementRestInteractionCode enum
Members
health.fhir.r4: CapabilityStatementRestMode
CapabilityStatementRestMode enum
Members
health.fhir.r4: CapabilityStatementRestResourceConditionalDelete
CapabilityStatementRestResourceConditionalDelete enum
Members
health.fhir.r4: CapabilityStatementRestResourceConditionalRead
CapabilityStatementRestResourceConditionalRead enum
Members
health.fhir.r4: CapabilityStatementRestResourceInteractionCode
CapabilityStatementRestResourceInteractionCode enum
Members
health.fhir.r4: CapabilityStatementRestResourceReferencePolicy
CapabilityStatementRestResourceReferencePolicy enum
Members
health.fhir.r4: CapabilityStatementRestResourceSearchParamType
CapabilityStatementRestResourceSearchParamType enum
Members
health.fhir.r4: CapabilityStatementRestResourceVersioning
CapabilityStatementRestResourceVersioning enum
Members
health.fhir.r4: CapabilityStatementStatus
CapabilityStatementStatus enum
Members
health.fhir.r4: CarePlanActivityDetailKind
CarePlanActivityDetailKind enum
Members
health.fhir.r4: CarePlanActivityDetailStatus
CarePlanActivityDetailStatus enum
Members
health.fhir.r4: CarePlanIntent
CarePlanIntent enum
Members
health.fhir.r4: CarePlanStatus
CarePlanStatus enum
Members
health.fhir.r4: CareTeamStatus
CareTeamStatus enum
Members
health.fhir.r4: CatalogEntryRelatedEntryRelationtype
CatalogEntryRelatedEntryRelationtype enum
Members
health.fhir.r4: CatalogEntryStatus
CatalogEntryStatus enum
Members
health.fhir.r4: ChargeItemDefinitionPropertyGroupPriceComponentType
ChargeItemDefinitionPropertyGroupPriceComponentType enum
Members
health.fhir.r4: ChargeItemDefinitionStatus
ChargeItemDefinitionStatus enum
Members
health.fhir.r4: ChargeItemStatus
ChargeItemStatus enum
Members
health.fhir.r4: ClaimResponseOutcome
ClaimResponseOutcome enum
Members
health.fhir.r4: ClaimResponseProcessNoteType
ClaimResponseProcessNoteType enum
Members
health.fhir.r4: ClaimResponseStatus
ClaimResponseStatus enum
Members
health.fhir.r4: ClaimResponseUse
ClaimResponseUse enum
Members
health.fhir.r4: ClaimStatus
ClaimStatus enum
Members
health.fhir.r4: ClaimUse
ClaimUse enum
Members
health.fhir.r4: ClinicalImpressionStatus
ClinicalImpressionStatus enum
Members
health.fhir.r4: CodeSystemContent
CodeSystemContent enum
Members
health.fhir.r4: CodeSystemFilterOperator
CodeSystemFilterOperator enum
Members
health.fhir.r4: CodeSystemHierarchyMeaning
CodeSystemHierarchyMeaning enum
Members
health.fhir.r4: CodeSystemPropertyType
CodeSystemPropertyType enum
Members
health.fhir.r4: CodeSystemStatus
CodeSystemStatus enum
Members
health.fhir.r4: CommunicationPriority
CommunicationPriority enum
Members
health.fhir.r4: CommunicationRequestPriority
CommunicationRequestPriority enum
Members
health.fhir.r4: CommunicationRequestStatus
CommunicationRequestStatus enum
Members
health.fhir.r4: CommunicationStatus
CommunicationStatus enum
Members
health.fhir.r4: CompartmentDefinitionCode
CompartmentDefinitionCode enum
Members
health.fhir.r4: CompartmentDefinitionStatus
CompartmentDefinitionStatus enum
Members
health.fhir.r4: CompositionAttesterMode
CompositionAttesterMode enum
Members
health.fhir.r4: CompositionRelatesToCode
CompositionRelatesToCode enum
Members
health.fhir.r4: CompositionSectionMode
CompositionSectionMode enum
Members
health.fhir.r4: CompositionStatus
CompositionStatus enum
Members
health.fhir.r4: ConceptMapGroupElementTargetEquivalence
ConceptMapGroupElementTargetEquivalence enum
Members
health.fhir.r4: ConceptMapGroupUnmappedMode
ConceptMapGroupUnmappedMode enum
Members
health.fhir.r4: ConceptMapStatus
ConceptMapStatus enum
Members
health.fhir.r4: ConsentProvisionDataMeaning
ConsentProvisionDataMeaning enum
Members
health.fhir.r4: ConsentProvisionType
ConsentProvisionType enum
Members
health.fhir.r4: ConsentStatus
ConsentStatus enum
Members
health.fhir.r4: ContactPointSystem
Members
health.fhir.r4: ContactPointUse
Members
health.fhir.r4: ContractContentDefinitionPublicationStatus
ContractContentDefinitionPublicationStatus enum
Members
health.fhir.r4: ContractStatus
ContractStatus enum
Members
health.fhir.r4: ContributerType
Members
health.fhir.r4: ContributorType
Members
health.fhir.r4: CoverageEligibilityRequestPurpose
CoverageEligibilityRequestPurpose enum
Members
health.fhir.r4: CoverageEligibilityRequestStatus
CoverageEligibilityRequestStatus enum
Members
health.fhir.r4: CoverageEligibilityResponseOutcome
CoverageEligibilityResponseOutcome enum
Members
health.fhir.r4: CoverageEligibilityResponsePurpose
CoverageEligibilityResponsePurpose enum
Members
health.fhir.r4: CoverageEligibilityResponseStatus
CoverageEligibilityResponseStatus enum
Members
health.fhir.r4: CoverageStatus
CoverageStatus enum
Members
health.fhir.r4: Daycode
Members
health.fhir.r4: DetectedIssueSeverity
DetectedIssueSeverity enum
Members
health.fhir.r4: DetectedIssueStatus
DetectedIssueStatus enum
Members
health.fhir.r4: DeviceDefinitionDeviceNameType
DeviceDefinitionDeviceNameType enum
Members
health.fhir.r4: DeviceDeviceNameType
DeviceDeviceNameType enum
Members
health.fhir.r4: DeviceMetricCalibrationState
DeviceMetricCalibrationState enum
Members
health.fhir.r4: DeviceMetricCalibrationType
DeviceMetricCalibrationType enum
Members
health.fhir.r4: DeviceMetricCategory
DeviceMetricCategory enum
Members
health.fhir.r4: DeviceMetricColor
DeviceMetricColor enum
Members
health.fhir.r4: DeviceMetricOperationalStatus
DeviceMetricOperationalStatus enum
Members
health.fhir.r4: DeviceRequestIntent
DeviceRequestIntent enum
Members
health.fhir.r4: DeviceRequestPriority
DeviceRequestPriority enum
Members
health.fhir.r4: DeviceRequestStatus
DeviceRequestStatus enum
Members
health.fhir.r4: DeviceStatus
DeviceStatus enum
Members
health.fhir.r4: DeviceUdiCarrierEntryType
DeviceUdiCarrierEntryType enum
Members
health.fhir.r4: DeviceUseStatementStatus
DeviceUseStatementStatus enum
Members
health.fhir.r4: DiagnosticReportStatus
DiagnosticReportStatus enum
Members
health.fhir.r4: DirectionCode
Members
health.fhir.r4: DocumentManifestStatus
DocumentManifestStatus enum
Members
health.fhir.r4: DocumentReferenceDocStatus
DocumentReferenceDocStatus enum
Members
health.fhir.r4: DocumentReferenceRelatesToCode
DocumentReferenceRelatesToCode enum
Members
health.fhir.r4: DocumentReferenceStatus
DocumentReferenceStatus enum
Members
health.fhir.r4: EffectEvidenceSynthesisResultsByExposureExposureState
EffectEvidenceSynthesisResultsByExposureExposureState enum
Members
health.fhir.r4: EffectEvidenceSynthesisStatus
EffectEvidenceSynthesisStatus enum
Members
health.fhir.r4: ElementDiscriminatorType
Members
health.fhir.r4: ElementSlicingRules
Members
health.fhir.r4: EncounterLocationStatus
EncounterLocationStatus enum
Members
health.fhir.r4: EncounterStatus
EncounterStatus enum
Members
health.fhir.r4: EncounterStatusHistoryStatus
EncounterStatusHistoryStatus enum
Members
health.fhir.r4: EndpointStatus
EndpointStatus enum
Members
health.fhir.r4: EnrollmentRequestStatus
EnrollmentRequestStatus enum
Members
health.fhir.r4: EnrollmentResponseOutcome
EnrollmentResponseOutcome enum
Members
health.fhir.r4: EnrollmentResponseStatus
EnrollmentResponseStatus enum
Members
health.fhir.r4: EpisodeOfCareStatus
EpisodeOfCareStatus enum
Members
health.fhir.r4: EpisodeOfCareStatusHistoryStatus
EpisodeOfCareStatusHistoryStatus enum
Members
health.fhir.r4: EventDefinitionStatus
EventDefinitionStatus enum
Members
health.fhir.r4: EvidenceStatus
EvidenceStatus enum
Members
health.fhir.r4: EvidenceVariableCharacteristicGroupMeasure
EvidenceVariableCharacteristicGroupMeasure enum
Members
health.fhir.r4: EvidenceVariableStatus
EvidenceVariableStatus enum
Members
health.fhir.r4: EvidenceVariableType
EvidenceVariableType enum
Members
health.fhir.r4: ExampleScenarioActorType
ExampleScenarioActorType enum
Members
health.fhir.r4: ExampleScenarioStatus
ExampleScenarioStatus enum
Members
health.fhir.r4: ExplanationOfBenefitOutcome
ExplanationOfBenefitOutcome enum
Members
health.fhir.r4: ExplanationOfBenefitProcessNoteType
ExplanationOfBenefitProcessNoteType enum
Members
health.fhir.r4: ExplanationOfBenefitStatus
ExplanationOfBenefitStatus enum
Members
health.fhir.r4: ExplanationOfBenefitUse
ExplanationOfBenefitUse enum
Members
health.fhir.r4: FamilyMemberHistoryStatus
FamilyMemberHistoryStatus enum
Members
health.fhir.r4: FHIRInteractionLevel
FHIR Interaction levels
Members
health.fhir.r4: FHIRInteractionType
FHIR REST Interactions
Members
health.fhir.r4: FHIRPayloadFormat
FHIR Payload formats
Members
health.fhir.r4: FHIRSearchParameterModifier
FHIR search parameter modifiers
Members
health.fhir.r4: FHIRSearchParameterType
FHIR search parameter types
Members
health.fhir.r4: FlagStatus
FlagStatus enum
Members
health.fhir.r4: GoalLifecycleStatus
GoalLifecycleStatus enum
Members
health.fhir.r4: GraphDefinitionLinkTargetCompartmentCode
GraphDefinitionLinkTargetCompartmentCode enum
Members
health.fhir.r4: GraphDefinitionLinkTargetCompartmentRule
GraphDefinitionLinkTargetCompartmentRule enum
Members
health.fhir.r4: GraphDefinitionLinkTargetCompartmentUse
GraphDefinitionLinkTargetCompartmentUse enum
Members
health.fhir.r4: GraphDefinitionStatus
GraphDefinitionStatus enum
Members
health.fhir.r4: GroupType
GroupType enum
Members
health.fhir.r4: GuidanceResponseStatus
GuidanceResponseStatus enum
Members
health.fhir.r4: HealthcareServiceAvailableTimeDaysOfWeek
HealthcareServiceAvailableTimeDaysOfWeek enum
Members
health.fhir.r4: HTTPVerb
Members
health.fhir.r4: HumanNameUse
Members
health.fhir.r4: IdentifierUse
Members
health.fhir.r4: ImagingStudyStatus
ImagingStudyStatus enum
Members
health.fhir.r4: ImmunizationEvaluationStatus
ImmunizationEvaluationStatus enum
Members
health.fhir.r4: ImmunizationStatus
ImmunizationStatus enum
Members
health.fhir.r4: ImplementationGuideDefinitionPageGeneration
ImplementationGuideDefinitionPageGeneration enum
Members
health.fhir.r4: ImplementationGuideDefinitionParameterCode
ImplementationGuideDefinitionParameterCode enum
Members
health.fhir.r4: ImplementationGuideStatus
ImplementationGuideStatus enum
Members
health.fhir.r4: InsurancePlanStatus
InsurancePlanStatus enum
Members
health.fhir.r4: InvoiceLineItemPriceComponentType
InvoiceLineItemPriceComponentType enum
Members
health.fhir.r4: InvoiceStatus
InvoiceStatus enum
Members
health.fhir.r4: IssueType
Code that describes the type of issue.
Members
health.fhir.r4: LibraryStatus
LibraryStatus enum
Members
health.fhir.r4: LinkageItemType
LinkageItemType enum
Members
health.fhir.r4: ListMode
ListMode enum
Members
health.fhir.r4: ListStatus
ListStatus enum
Members
health.fhir.r4: LocationHoursOfOperationDaysOfWeek
LocationHoursOfOperationDaysOfWeek enum
Members
health.fhir.r4: LocationMode
LocationMode enum
Members
health.fhir.r4: LocationStatus
LocationStatus enum
Members
health.fhir.r4: MeasureReportStatus
MeasureReportStatus enum
Members
health.fhir.r4: MeasureReportType
MeasureReportType enum
Members
health.fhir.r4: MeasureStatus
MeasureStatus enum
Members
health.fhir.r4: MediaStatus
MediaStatus enum
Members
health.fhir.r4: MedicationAdministrationStatus
MedicationAdministrationStatus enum
Members
health.fhir.r4: MedicationDispenseStatus
MedicationDispenseStatus enum
Members
health.fhir.r4: MedicationKnowledgeStatus
MedicationKnowledgeStatus enum
Members
health.fhir.r4: MedicationRequestIntent
MedicationRequestIntent enum
Members
health.fhir.r4: MedicationRequestPriority
MedicationRequestPriority enum
Members
health.fhir.r4: MedicationRequestStatus
MedicationRequestStatus enum
Members
health.fhir.r4: MedicationStatementStatus
MedicationStatementStatus enum
Members
health.fhir.r4: MedicationStatus
MedicationStatus enum
Members
health.fhir.r4: MessageDefinitionCategory
MessageDefinitionCategory enum
Members
health.fhir.r4: MessageDefinitionResponseRequired
MessageDefinitionResponseRequired enum
Members
health.fhir.r4: MessageDefinitionStatus
MessageDefinitionStatus enum
Members
health.fhir.r4: MessageDirection
Enum to indicate message flow direction
Members
health.fhir.r4: MessageHeaderResponseCode
MessageHeaderResponseCode enum
Members
health.fhir.r4: MolecularSequenceQualityType
MolecularSequenceQualityType enum
Members
health.fhir.r4: MolecularSequenceReferenceSeqOrientation
MolecularSequenceReferenceSeqOrientation enum
Members
health.fhir.r4: MolecularSequenceReferenceSeqStrand
MolecularSequenceReferenceSeqStrand enum
Members
health.fhir.r4: MolecularSequenceRepositoryType
MolecularSequenceRepositoryType enum
Members
health.fhir.r4: MolecularSequenceType
MolecularSequenceType enum
Members
health.fhir.r4: NamingSystemKind
NamingSystemKind enum
Members
health.fhir.r4: NamingSystemStatus
NamingSystemStatus enum
Members
health.fhir.r4: NamingSystemUniqueIdType
NamingSystemUniqueIdType enum
Members
health.fhir.r4: NutritionOrderIntent
NutritionOrderIntent enum
Members
health.fhir.r4: NutritionOrderStatus
NutritionOrderStatus enum
Members
health.fhir.r4: ObservationDefinitionPermittedDataType
ObservationDefinitionPermittedDataType enum
Members
health.fhir.r4: ObservationDefinitionQualifiedIntervalCategory
ObservationDefinitionQualifiedIntervalCategory enum
Members
health.fhir.r4: ObservationDefinitionQualifiedIntervalGender
ObservationDefinitionQualifiedIntervalGender enum
Members
health.fhir.r4: ObservationStatus
ObservationStatus enum
Members
health.fhir.r4: ObservationStatusOne
ObservationStatusOne enum
Members
health.fhir.r4: OperationDefinitionKind
OperationDefinitionKind enum
Members
health.fhir.r4: OperationDefinitionParameterBindingStrength
OperationDefinitionParameterBindingStrength enum
Members
health.fhir.r4: OperationDefinitionParameterSearchType
OperationDefinitionParameterSearchType enum
Members
health.fhir.r4: OperationDefinitionParameterUse
OperationDefinitionParameterUse enum
Members
health.fhir.r4: OperationDefinitionStatus
OperationDefinitionStatus enum
Members
health.fhir.r4: OperationOutcomeIssueSeverity
OperationOutcomeIssueSeverity enum
Members
health.fhir.r4: ParameterDefinitionUse
Members
health.fhir.r4: PatientContactGender
PatientContactGender enum
Members
health.fhir.r4: PatientGender
PatientGender enum
Members
health.fhir.r4: PatientLinkType
PatientLinkType enum
Members
health.fhir.r4: PaymentNoticeStatus
PaymentNoticeStatus enum
Members
health.fhir.r4: PaymentReconciliationOutcome
PaymentReconciliationOutcome enum
Members
health.fhir.r4: PaymentReconciliationProcessNoteType
PaymentReconciliationProcessNoteType enum
Members
health.fhir.r4: PaymentReconciliationStatus
PaymentReconciliationStatus enum
Members
health.fhir.r4: PersonGender
PersonGender enum
Members
health.fhir.r4: PersonLinkAssurance
PersonLinkAssurance enum
Members
health.fhir.r4: PlanDefinitionActionCardinalityBehavior
PlanDefinitionActionCardinalityBehavior enum
Members
health.fhir.r4: PlanDefinitionActionConditionKind
PlanDefinitionActionConditionKind enum
Members
health.fhir.r4: PlanDefinitionActionGroupingBehavior
PlanDefinitionActionGroupingBehavior enum
Members
health.fhir.r4: PlanDefinitionActionParticipantType
PlanDefinitionActionParticipantType enum
Members
health.fhir.r4: PlanDefinitionActionPrecheckBehavior
PlanDefinitionActionPrecheckBehavior enum
Members
health.fhir.r4: PlanDefinitionActionPriority
PlanDefinitionActionPriority enum
Members
health.fhir.r4: PlanDefinitionActionRelatedActionRelationship
PlanDefinitionActionRelatedActionRelationship enum
Members
health.fhir.r4: PlanDefinitionActionRequiredBehavior
PlanDefinitionActionRequiredBehavior enum
Members
health.fhir.r4: PlanDefinitionActionSelectionBehavior
PlanDefinitionActionSelectionBehavior enum
Members
health.fhir.r4: PlanDefinitionStatus
PlanDefinitionStatus enum
Members
health.fhir.r4: PractitionerGender
PractitionerGender enum
Members
health.fhir.r4: PractitionerRoleAvailableTimeDaysOfWeek
PractitionerRoleAvailableTimeDaysOfWeek enum
Members
health.fhir.r4: Prefix
For the ordered parameter types of number, date, and quantity, a prefix to the parameter value may be used to control the nature of the matching
Members
health.fhir.r4: ProcedureStatus
ProcedureStatus enum
Members
health.fhir.r4: ProvenanceEntityRole
ProvenanceEntityRole enum
Members
health.fhir.r4: QuantityComparatorCode
Members
health.fhir.r4: QuestionnaireItemEnableBehavior
QuestionnaireItemEnableBehavior enum
Members
health.fhir.r4: QuestionnaireItemEnableWhenOperator
QuestionnaireItemEnableWhenOperator enum
Members
health.fhir.r4: QuestionnaireItemType
QuestionnaireItemType enum
Members
health.fhir.r4: QuestionnaireResponseStatus
QuestionnaireResponseStatus enum
Members
health.fhir.r4: QuestionnaireStatus
QuestionnaireStatus enum
Members
health.fhir.r4: RelatedPersonGender
RelatedPersonGender enum
Members
health.fhir.r4: RepeatCode
Members
health.fhir.r4: RequestGroupActionCardinalityBehavior
RequestGroupActionCardinalityBehavior enum
Members
health.fhir.r4: RequestGroupActionConditionKind
RequestGroupActionConditionKind enum
Members
health.fhir.r4: RequestGroupActionGroupingBehavior
RequestGroupActionGroupingBehavior enum
Members
health.fhir.r4: RequestGroupActionPrecheckBehavior
RequestGroupActionPrecheckBehavior enum
Members
health.fhir.r4: RequestGroupActionPriority
RequestGroupActionPriority enum
Members
health.fhir.r4: RequestGroupActionRelatedActionRelationship
RequestGroupActionRelatedActionRelationship enum
Members
health.fhir.r4: RequestGroupActionRequiredBehavior
RequestGroupActionRequiredBehavior enum
Members
health.fhir.r4: RequestGroupActionSelectionBehavior
RequestGroupActionSelectionBehavior enum
Members
health.fhir.r4: RequestGroupIntent
RequestGroupIntent enum
Members
health.fhir.r4: RequestGroupPriority
RequestGroupPriority enum
Members
health.fhir.r4: RequestGroupStatus
RequestGroupStatus enum
Members
health.fhir.r4: ResearchDefinitionStatus
ResearchDefinitionStatus enum
Members
health.fhir.r4: ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure
ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure enum
Members
health.fhir.r4: ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure
ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure enum
Members
health.fhir.r4: ResearchElementDefinitionStatus
ResearchElementDefinitionStatus enum
Members
health.fhir.r4: ResearchElementDefinitionType
ResearchElementDefinitionType enum
Members
health.fhir.r4: ResearchElementDefinitionVariableType
ResearchElementDefinitionVariableType enum
Members
health.fhir.r4: ResearchStudyStatus
ResearchStudyStatus enum
Members
health.fhir.r4: ResearchSubjectStatus
ResearchSubjectStatus enum
Members
health.fhir.r4: RiskAssessmentStatus
RiskAssessmentStatus enum
Members
health.fhir.r4: RiskEvidenceSynthesisStatus
RiskEvidenceSynthesisStatus enum
Members
health.fhir.r4: SearchEntryMode
Members
health.fhir.r4: SearchParameterComparator
SearchParameterComparator enum
Members
health.fhir.r4: SearchParameterModifier
SearchParameterModifier enum
Members
health.fhir.r4: SearchParameterStatus
SearchParameterStatus enum
Members
health.fhir.r4: SearchParameterType
SearchParameterType enum
Members
health.fhir.r4: SearchParameterXpathUsage
SearchParameterXpathUsage enum
Members
health.fhir.r4: ServiceRequestIntent
ServiceRequestIntent enum
Members
health.fhir.r4: ServiceRequestPriority
ServiceRequestPriority enum
Members
health.fhir.r4: ServiceRequestStatus
ServiceRequestStatus enum
Members
health.fhir.r4: Severity
Level the issue affects the success of the action.
Members
health.fhir.r4: SlotStatus
SlotStatus enum
Members
health.fhir.r4: SpecimenDefinitionTypeTestedPreference
SpecimenDefinitionTypeTestedPreference enum
Members
health.fhir.r4: SpecimenStatus
SpecimenStatus enum
Members
health.fhir.r4: StatusCode
Members
health.fhir.r4: StrengthCode
Members
health.fhir.r4: StructureDefinitionContextType
StructureDefinitionContextType enum
Members
health.fhir.r4: StructureDefinitionDerivation
StructureDefinitionDerivation enum
Members
health.fhir.r4: StructureDefinitionKind
StructureDefinitionKind enum
Members
health.fhir.r4: StructureDefinitionStatus
StructureDefinitionStatus enum
Members
health.fhir.r4: StructureMapGroupInputMode
StructureMapGroupInputMode enum
Members
health.fhir.r4: StructureMapGroupRuleSourceListMode
StructureMapGroupRuleSourceListMode enum
Members
health.fhir.r4: StructureMapGroupRuleTargetContextType
StructureMapGroupRuleTargetContextType enum
Members
health.fhir.r4: StructureMapGroupRuleTargetListMode
StructureMapGroupRuleTargetListMode enum
Members
health.fhir.r4: StructureMapGroupRuleTargetTransform
StructureMapGroupRuleTargetTransform enum
Members
health.fhir.r4: StructureMapGroupTypeMode
StructureMapGroupTypeMode enum
Members
health.fhir.r4: StructureMapStatus
StructureMapStatus enum
Members
health.fhir.r4: StructureMapStructureMode
StructureMapStructureMode enum
Members
health.fhir.r4: SubscriptionChannelType
SubscriptionChannelType enum
Members
health.fhir.r4: SubscriptionStatus
SubscriptionStatus enum
Members
health.fhir.r4: SubstanceStatus
SubstanceStatus enum
Members
health.fhir.r4: SupplyDeliveryStatus
SupplyDeliveryStatus enum
Members
health.fhir.r4: SupplyRequestPriority
SupplyRequestPriority enum
Members
health.fhir.r4: SupplyRequestStatus
SupplyRequestStatus enum
Members
health.fhir.r4: TaskIntent
TaskIntent enum
Members
health.fhir.r4: TaskPriority
TaskPriority enum
Members
health.fhir.r4: TaskStatus
TaskStatus enum
Members
health.fhir.r4: TerminologyCapabilitiesCodeSearch
TerminologyCapabilitiesCodeSearch enum
Members
health.fhir.r4: TerminologyCapabilitiesKind
TerminologyCapabilitiesKind enum
Members
health.fhir.r4: TerminologyCapabilitiesStatus
TerminologyCapabilitiesStatus enum
Members
health.fhir.r4: TestReportParticipantType
TestReportParticipantType enum
Members
health.fhir.r4: TestReportResult
TestReportResult enum
Members
health.fhir.r4: TestReportSetupActionAssertResult
TestReportSetupActionAssertResult enum
Members
health.fhir.r4: TestReportSetupActionOperationResult
TestReportSetupActionOperationResult enum
Members
health.fhir.r4: TestReportStatus
TestReportStatus enum
Members
health.fhir.r4: TestScriptSetupActionAssertDirection
TestScriptSetupActionAssertDirection enum
Members
health.fhir.r4: TestScriptSetupActionAssertOperator
TestScriptSetupActionAssertOperator enum
Members
health.fhir.r4: TestScriptSetupActionAssertRequestMethod
TestScriptSetupActionAssertRequestMethod enum
Members
health.fhir.r4: TestScriptSetupActionAssertResponse
TestScriptSetupActionAssertResponse enum
Members
health.fhir.r4: TestScriptSetupActionOperationMethod
TestScriptSetupActionOperationMethod enum
Members
health.fhir.r4: TestScriptStatus
TestScriptStatus enum
Members
health.fhir.r4: Timecode
Members
health.fhir.r4: TypeAggregation
Members
health.fhir.r4: TypeVersioning
Members
health.fhir.r4: ValueSetComposeIncludeFilterOp
ValueSetComposeIncludeFilterOp enum
Members
health.fhir.r4: ValueSetStatus
ValueSetStatus enum
Members
health.fhir.r4: VerificationResultStatus
VerificationResultStatus enum
Members
health.fhir.r4: VisionPrescriptionLensSpecificationEye
VisionPrescriptionLensSpecificationEye enum
Members
health.fhir.r4: VisionPrescriptionLensSpecificationPrismBase
VisionPrescriptionLensSpecificationPrismBase enum
Members
health.fhir.r4: VisionPrescriptionStatus
VisionPrescriptionStatus enum
Members
Variables
health.fhir.r4: terminologyProcessor
Terminology processor instance
health.fhir.r4: fhirRegistry
FHIR registry instance
health.fhir.r4: FHIR_VALUE_SETS
health.fhir.r4: FHIR_CODE_SYSTEMS
Annotations
health.fhir.r4: ContainerDefinition
health.fhir.r4: DataTypeDefinition
health.fhir.r4: ResourceDefinition
Records
health.fhir.r4: Account
FHIR Account resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ACCOUNT(default RESOURCE_NAME_ACCOUNT) - The type of the resource describes
- meta BaseAccountMeta(default { profile : [PROFILE_BASE_ACCOUNT] }) - 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.
- coverage AccountCoverage[]? - The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
- owner Reference? - Indicates the service area, hospital, department, etc. with responsibility for managing the Account.
- identifier Identifier[]? - Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).
- partOf Reference? - Reference to a parent Account.
- 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.
- subject Reference[]? - Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
- 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 string? - Provides additional information about what the account tracks and how it is used.
- guarantor AccountGuarantor[]? - The parties responsible for balancing the account if other payment options fall short.
- language code? - The base language in which the resource is written.
- 'type CodeableConcept? - Categorizes the account for reporting and searching purposes.
- servicePeriod Period? - The date range of services associated with this account.
- 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.
- name string? - Name used for the account when displaying it to humans in reports, etc.
- 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.
- 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.
- status AccountStatus - Indicates whether the account is presently used/usable or not.
- never... - Rest field
health.fhir.r4: AccountCoverage
FHIR AccountCoverage datatype record.
Fields
- coverage Reference - The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
- 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).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- priority positiveInt? - The priority of the coverage in the context of this account.
health.fhir.r4: AccountGuarantor
FHIR AccountGuarantor 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.
- period Period? - The timeframe during which the guarantor accepts responsibility for the account.
- onHold boolean? - A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
- 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.
- party Reference - The entity who is responsible.
health.fhir.r4: ActivityDefinition
FHIR ActivityDefinition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ACTIVITYDEFINITION(default RESOURCE_NAME_ACTIVITYDEFINITION) - The type of the resource describes
- meta BaseActivityDefinitionMeta(default { profile : [PROFILE_BASE_ACTIVITYDEFINITION] }) - 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 activity definition 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 activity definition changes.
- copyright markdown? - A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
- 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).
- usage string? - A detailed description of how the activity definition is used from a clinical perspective.
- productReference Reference? - Identifies the food, drug or other product being consumed or supplied in the activity.
- experimental boolean? - A Boolean value to indicate that this activity definition 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.
- participant ActivityDefinitionParticipant[]? - Indicates who should participate in performing the action described.
- observationResultRequirement Reference[]? - Defines the observations that are expected to be produced by the action.
- contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.
- endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.
- timingAge Age? - The period, timing or frequency upon which the described activity is to occur.
- 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.
- doNotPerform boolean? - Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
- timingDuration Duration? - The period, timing or frequency upon which the described activity is to occur.
- identifier Identifier[]? - A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.
- effectivePeriod Period? - The period during which the activity definition content was or is planned to be in active use.
- author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.
- kind code? - A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
- profile canonical? - A profile to which the target of the activity definition is expected to conform.
- priority ActivityDefinitionPriority? - Indicates how quickly the activity should be addressed with respect to other requests.
- 'version string? - The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
- timingRange Range? - The period, timing or frequency upon which the described activity is to occur.
- lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- subtitle string? - An explanatory or alternate title for the activity definition giving additional information about its content.
- name string? - A natural language name identifying the activity definition. 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 activity definition.
- topic CodeableConcept[]? - Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
- 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 activity definition instances.
- productCodeableConcept CodeableConcept? - Identifies the food, drug or other product being consumed or supplied in the activity.
- status ActivityDefinitionStatus - The status of this activity definition. Enables tracking the life-cycle of the content.
- dosage Dosage[]? - Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
- 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.
- approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- code CodeableConcept? - Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
- subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the activity being defined.
- purpose markdown? - Explanation of why this activity definition is needed and why it has been designed as it has.
- jurisdiction CodeableConcept[]? - A legal or geographic region in which the activity definition is intended to be used.
- description markdown? - A free text natural language description of the activity definition from a consumer's perspective.
- specimenRequirement Reference[]? - Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
- title string? - A short, descriptive, user-friendly title for the activity definition.
- transform canonical? - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
- dynamicValue ActivityDefinitionDynamicValue[]? - Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
- library canonical[]? - A reference to a Library resource containing any formal logic used by the activity definition.
- editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.
- quantity Quantity? - Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
- timingTiming Timing? - The period, timing or frequency upon which the described activity is to occur.
- timingPeriod Period? - The period, timing or frequency upon which the described activity is to occur.
- reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.
- intent ActivityDefinitionIntent? - Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
- subjectReference Reference? - A code or group definition that describes the intended subject of the activity being defined.
- observationRequirement Reference[]? - Defines observation requirements for the action to be performed, such as body weight or surface area.
- url uri? - An absolute URI that is used to identify this activity definition 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
- bodySite CodeableConcept[]? - Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
- 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.
- location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
- timingDateTime dateTime? - The period, timing or frequency upon which the described activity is to occur.
- never... - Rest field
health.fhir.r4: ActivityDefinitionDynamicValue
FHIR ActivityDefinitionDynamicValue datatype record.
Fields
- path string - The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
- 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.
- expression Expression - An expression specifying the value of the customized element.
- 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.
health.fhir.r4: ActivityDefinitionParticipant
FHIR ActivityDefinitionParticipant 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.
- role CodeableConcept? - The role the participant should play in performing the described action.
- 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.
- 'type ActivityDefinitionParticipantType - The type of participant in the action.
health.fhir.r4: Address
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
Fields
- url uri -
- valueAddress Address -
health.fhir.r4: AdverseEvent
FHIR AdverseEvent resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ADVERSEEVENT(default RESOURCE_NAME_ADVERSEEVENT) - The type of the resource describes
- meta BaseAdverseEventMeta(default { profile : [PROFILE_BASE_ADVERSEEVENT] }) - 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 perhaps time) when the adverse event occurred.
- 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.
- study Reference[]? - AdverseEvent.study.
- subjectMedicalHistory Reference[]? - AdverseEvent.subjectMedicalHistory.
- subject Reference - This subject or group impacted by the event.
- 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).
- language code? - The base language in which the resource is written.
- contributor Reference[]? - Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
- 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.
- event CodeableConcept? - This element defines the specific type of event that occurred or that was prevented from occurring.
- outcome CodeableConcept? - Describes the type of outcome from the adverse event.
- severity CodeableConcept? - Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
- identifier Identifier? - Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Information on who recorded the adverse event. May be the patient or a practitioner.
- actuality AdverseEventActuality - Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
- recordedDate dateTime? - The date on which the existence of the AdverseEvent was first recorded.
- referenceDocument Reference[]? - AdverseEvent.referenceDocument.
- encounter Reference? - The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
- suspectEntity AdverseEventSuspectEntity[]? - Describes the entity that is suspected to have caused the adverse event.
- 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.
- resultingCondition Reference[]? - Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
- seriousness CodeableConcept? - Assessment whether this event was of real importance.
- detected dateTime? - Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
- 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.
- location Reference? - The information about where the adverse event occurred.
- category CodeableConcept[]? - The overall type of event, intended for search and filtering purposes.
- never... - Rest field
health.fhir.r4: AdverseEventSuspectEntity
FHIR AdverseEventSuspectEntity 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.
- instance Reference - Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
- 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.
- causality AdverseEventSuspectEntityCausality[]? - Information on the possible cause of the event.
health.fhir.r4: AdverseEventSuspectEntityCausality
FHIR AdverseEventSuspectEntityCausality datatype record.
Fields
- assessment CodeableConcept? - Assessment of if the entity caused the event.
- 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.
- productRelatedness string? - AdverseEvent.suspectEntity.causalityProductRelatedness.
- method CodeableConcept? - ProbabilityScale | Bayesian | Checklist.
- author Reference? - AdverseEvent.suspectEntity.causalityAuthor.
- 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.
health.fhir.r4: Age
Fields
- Fields Included from *Quantity
- id string? -
- extension Extension[]? -
- ageValue integer? -
- unit string? -
- system uri? -
- code code? -
health.fhir.r4: AgeExtension
Fields
- url uri -
- valueAge Age -
health.fhir.r4: AllergyIntolerance
FHIR AllergyIntolerance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_ALLERGYINTOLERANCE(default RESOURCE_NAME_ALLERGYINTOLERANCE) - The type of the resource describes
- meta BaseAllergyIntoleranceMeta(default { profile : [PROFILE_BASE_ALLERGYINTOLERANCE] }) - 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.
- note Annotation[]? - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- 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.
- code CodeableConcept? - Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- onsetRange Range? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 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).
- criticality AllergyIntoleranceCriticality? - Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
- language code? - The base language in which the resource is written.
- clinicalStatus CodeableConcept? - The clinical status of the allergy or intolerance.
- onsetDateTime dateTime? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 'type AllergyIntoleranceType? - Identification of the underlying physiological mechanism for the reaction risk.
- onsetString string? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- onsetAge Age? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- lastOccurrence dateTime? - Represents the date and/or time of the last known occurrence of a reaction event.
- patient Reference - The patient who has the allergy or intolerance.
- 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[]? - Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- onsetPeriod Period? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- reaction AllergyIntoleranceReaction[]? - Details about each adverse reaction event linked to exposure to the identified substance.
- verificationStatus CodeableConcept? - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
- recordedDate dateTime? - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
- encounter Reference? - The encounter when the allergy or intolerance was asserted.
- 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.
- asserter Reference? - The source of the information about the allergy that is recorded.
- 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.
- category AllergyIntoleranceCategory[]? - Category of the identified substance.
- never... - Rest field
health.fhir.r4: AllergyIntoleranceReaction
FHIR AllergyIntoleranceReaction datatype record.
Fields
- severity AllergyIntoleranceReactionSeverity? - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
- note Annotation[]? - Additional text about the adverse reaction event not captured in other 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.
- manifestation CodeableConcept[] - Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
- 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).
- substance CodeableConcept? - Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- description string? - Text description about the reaction as a whole, including details of the manifestation if required.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- onset dateTime? - Record of the date and/or time of the onset of the Reaction.
- exposureRoute CodeableConcept? - Identification of the route by which the subject was exposed to the substance.
health.fhir.r4: Annotation
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
Fields
- url uri -
- valueAnnotation Annotation -
health.fhir.r4: ApiInfo
FHIR API information.
Fields
- resourceTypereadonly string - FHIR resource type
- searchParametersreadonly string[] - supported search parameters
health.fhir.r4: Appointment
FHIR Appointment resource record.
Fields
- Fields Included from *DomainResource