Package org.hl7.fhir.r5.renderers.utils
Class RenderingContext
java.lang.Object
org.hl7.fhir.utilities.i18n.I18nBase
org.hl7.fhir.utilities.i18n.RenderingI18nContext
org.hl7.fhir.r5.renderers.utils.RenderingContext
Managing Language when rendering
You can specify a language to use when rendering resources by setting the setLocale() on
the super class. The locale drives the following:
- choice of java supplied rendering phrase, if translations are provided for the locale
- integer and date formats used (but see below for date formats)
- automatic translation of coded values, if language supplements are available
- choosing text representation considering the FHIR translation extension
By default, the locale is null, and the default locale for the underlying system is used.
If you set locale to a specific value, then that value will be used instead of the default locale.
By default, only a single language is rendered, based on the locale. Where resources contain
multiple language content (designations in CodeSystem and ValueSet, or using the translation
extension), you can control what languages are presented using the properties multiLanguagePolicy
and languages
- multiLanguagePolicy: NONE (default), DESIGNATIONS, ALL
- languages: a list of allowed languages. Default is empty which means all languages in scope via multiLanguagePolicy
Managing Date/Time Formatting
This class has multiple parameters that influence date/time formatting when rendering resources
- The default rendering is using the default java locale as above
- If you setLocale() to something, then the defaults for the locale will be used
- Else you can set the values of dateTimeFormat, dateFormat, dateYearFormat and dateYearMonthFormat
If you set the value of locale, the values of dateTimeFormat, dateFormat, dateYearFormat and dateYearMonthFormat are
reset to the system defaults
Timezones: by default, date/times are rendered in their source timezone
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static enum
static enum
static interface
static interface
static enum
static enum
static enum
static class
static enum
What kind of user the renderer is targeting - end users, or technical users This affects the way codes and references are renderedstatic enum
-
Field Summary
Fields inherited from class org.hl7.fhir.utilities.i18n.RenderingI18nContext
_NA, ACTOR_DEF_ACT, ACTOR_DEF_CAP, ACTOR_DEF_DER, ACTOR_DEF_TYP, ADD_BIND_ADD_BIND, ADD_BIND_ALL_REP, ADD_BIND_ANY, ADD_BIND_ANY_REP, ADD_BIND_CURR_BIND, ADD_BIND_DESIG_SYS, ADD_BIND_EX_BIND, ADD_BIND_EXT_PREF, ADD_BIND_GIVEN_CONT, ADD_BIND_MAX, ADD_BIND_MIN, ADD_BIND_NEW_REC, ADD_BIND_PREF_BIND, ADD_BIND_RECOM_VALUE_SET, ADD_BIND_REQ_BIND, ADD_BIND_UI, ADD_BIND_UI_BIND, ADD_BIND_UNKNOWN_PUR, ADD_BIND_VALID_EXT, ADD_BIND_VALID_REQ, ADD_BIND_VALUE_COMP, BUND_REND_INVALID_DOC, BUNDLE_ETAG, BUNDLE_HEADER_DOCUMENT_CONTENTS, BUNDLE_HEADER_ENTRY, BUNDLE_HEADER_ENTRY_URL, BUNDLE_HEADER_ROOT, BUNDLE_IF_MATCH, BUNDLE_IF_MOD, BUNDLE_IF_NON_MATCH, BUNDLE_IF_NONE, BUNDLE_LAST_MOD, BUNDLE_LOCATION, BUNDLE_REQUEST, BUNDLE_RESOURCE, BUNDLE_RESPONSE, BUNDLE_REV_EXCP, BUNDLE_SEARCH, BUNDLE_SEARCH_MODE, BUNDLE_SEARCH_SCORE, BUNDLE_SUMMARY, CANON_REND_COMMITTEE, CANON_REND_JSON, CANON_REND_MATURITY, CANON_REND_PUBLISHER, CANON_REND_SOURCE_RES, CANON_REND_TURTLE, CAPABILITY_ADD_SUPP_PROF, CAPABILITY_BASE_SYS, CAPABILITY_COMB_SEARCH_PAR, CAPABILITY_CORS_NO, CAPABILITY_CORS_YES, CAPABILITY_CREATE_INT, CAPABILITY_DELETE_INT, CAPABILITY_DOCUMENT_CAPS, CAPABILITY_ENDPOINTS, CAPABILITY_ERR_DET, CAPABILITY_EXT_OP, CAPABILITY_FHIR, CAPABILITY_FHIR_VER, CAPABILITY_HISTORY_INT, CAPABILITY_HISTORY_TYPE, CAPABILITY_IMP_VER, CAPABILITY_INT, CAPABILITY_INT_DESC, CAPABILITY_INT_SUMM, CAPABILITY_INTER_SUPP, CAPABILITY_MAY_SUPP, CAPABILITY_MESSAGING_CAP, CAPABILITY_MESSAGING_CAPS, CAPABILITY_MULT_EXT, CAPABILITY_NOTE_CAP, CAPABILITY_OP, CAPABILITY_OPER, CAPABILITY_OTH_RES_ENB, CAPABILITY_PATCH_INT, CAPABILITY_PROF_CONF, CAPABILITY_PROF_MAP, CAPABILITY_PROF_RES_DOC, CAPABILITY_PUB_BY, CAPABILITY_PUB_ON, CAPABILITY_READ_INT, CAPABILITY_REF_PROF, CAPABILITY_REQ_RECOM, CAPABILITY_RES_CONF, CAPABILITY_RES_ENB, CAPABILITY_RES_OPER, CAPABILITY_RES_PRO, CAPABILITY_RES_TYP, CAPABILITY_REST_CAPS, CAPABILITY_REST_CONFIG, CAPABILITY_REV_PROF, CAPABILITY_SEARCH_INT, CAPABILITY_SEARCH_PAR, CAPABILITY_SEARCH_PARS, CAPABILITY_SEARCHES, CAPABILITY_SHOULD_SUPP, CAPABILITY_SUMM_RES, CAPABILITY_SUMM_SYS_INT, CAPABILITY_SUPP, CAPABILITY_SUPP_FORM, CAPABILITY_SUPP_MSGS, CAPABILITY_SUPP_PATCH_FORM, CAPABILITY_SUPP_PROFS, CAPABILITY_SUPP_THE, CAPABILITY_SUPPS, CAPABILITY_SUPPS_THE, CAPABILITY_TYP_PRES, CAPABILITY_TYPS, CAPABILITY_UPDATE_INT, CAPABILITY_VREAD_INT, CAPABILTY_ALLOW_CAP, CAPABILTY_SHALL_SUPP, CODE_SYS_CODE_NOT_HERE, CODE_SYS_COMPLETE, CODE_SYS_COPY, CODE_SYS_DISP, CODE_SYS_DISP_PROP, CODE_SYS_EXAMPLE, CODE_SYS_FEAT, CODE_SYS_FOR_OID, CODE_SYS_FRAGMENT, CODE_SYS_IN_A_HIERARCHY, CODE_SYS_NOTPRESENT, CODE_SYS_PROP, CODE_SYS_REPLACED_BY, CODE_SYS_SUPPLEMENT, CODE_SYS_THE_VALUE_SET, CODE_SYS_UNDEF_HIER, CODE_SYS_UNKN_MODE, CODESYSTEM_CONCEPTS, CODESYSTEM_CONTENT_COMPLETE, CODESYSTEM_CONTENT_EXAMPLE, CODESYSTEM_CONTENT_FRAGMENT, CODESYSTEM_CONTENT_NOTPRESENT, CODESYSTEM_CONTENT_SUPPLEMENT, CODESYSTEM_DEPRECATED, CODESYSTEM_FILTER_OP, CODESYSTEM_FILTERS, CODESYSTEM_PROPS_DESC, CONC_MAP_CODE_SYS_UNSPEC, CONC_MAP_CODES, CONC_MAP_FRM, CONC_MAP_FROM, CONC_MAP_GRP, CONC_MAP_NO_PROD_USE, CONC_MAP_NOT_SPEC, CONC_MAP_PUB_ON, CONC_MAP_REL, CONC_MAP_SOURCE, CONC_MAP_SRC_DET, CONC_MAP_TO, CONC_MAP_TRGT, CONC_MAP_TRGT_DET, DATA_REND_AFTRBKFST, DATA_REND_AFTRDINR, DATA_REND_AFTRLUNCH, DATA_REND_AFTRMEALS, DATA_REND_AFTRWKNG, DATA_REND_ATBKFST, DATA_REND_ATDINR, DATA_REND_ATLUNCH, DATA_REND_ATT_DATA, DATA_REND_ATT_URL, DATA_REND_BASE64, DATA_REND_BFBKFST, DATA_REND_BFDINR, DATA_REND_BFLUNCH, DATA_REND_BFMEALS, DATA_REND_BFSLEEP, DATA_REND_BY, DATA_REND_CODES, DATA_REND_COND, DATA_REND_COUNT, DATA_REND_CURRENCY, DATA_REND_DATA, DATA_REND_DETAILS, DATA_REND_DETAILS_STATED, DATA_REND_DETAILS_STATED_ND, DATA_REND_DICOM, DATA_REND_DIM, DATA_REND_DURATION, DATA_REND_ERROR, DATA_REND_EVENTS, DATA_REND_EXCEPTION, DATA_REND_FACT, DATA_REND_FAX, DATA_REND_GLN, DATA_REND_ICD, DATA_REND_INT, DATA_REND_LIMIT, DATA_REND_LOINC, DATA_REND_LOWER, DATA_REND_MEALS, DATA_REND_MKDWN_LNK, DATA_REND_NO_DISP, DATA_REND_NOT_STAT, DATA_REND_ONCE, DATA_REND_ONGOING, DATA_REND_ORIGIN, DATA_REND_PER, DATA_REND_PERIOD, DATA_REND_PHONE, DATA_REND_RXNORM, DATA_REND_SEARCH, DATA_REND_SNOMED, DATA_REND_SORT, DATA_REND_SOURCE, DATA_REND_STARTING, DATA_REND_THESE_CODES, DATA_REND_TIMING, DATA_REND_TO_DO, DATA_REND_UNKNWN, DATA_REND_UNRD_EX, DATA_REND_UNTIL, DATA_REND_UP, DATA_REND_USE, DATA_REND_VALUESET, DATA_REND_VERSION, DIAG_REP_REND_AGE, DIAG_REP_REND_CODECON, DIAG_REP_REND_ERR, DIAG_REP_REND_FOR, DIAG_REP_REND_IDENTIFIER, DIAG_REP_REND_NOTRES, DIAG_REP_REND_OBS, DIAG_REP_REND_PER, DIAG_REP_REND_REFRAN, DIAG_REP_REND_REP, DIAG_REP_REND_REPDET, DIAG_REP_REND_UNABLE, DIAG_REP_REND_WHEN, DIAG_REP_SUMMARY, DIAG_REP_UNSPECIFIED_CODE, DIAG_REP_UNSPECIFIED_SUBJECT, DOCUMENT_SUMMARY, EX_SCEN_ALT, EX_SCEN_BEL, EX_SCEN_CONTA, EX_SCEN_ERR_REN, EX_SCEN_FVER, EX_SCEN_IN, EX_SCEN_OTH, EX_SCEN_POSTCON, EX_SCEN_PRECON, EX_SCEN_PROC, EX_SCEN_REC, EX_SCEN_RES, EX_SCEN_SEE, EX_SCEN_STEP, EX_SCEN_TIME, EX_SCEN_UN, EX_SCEN_UN_ACT, EX_SCEN_UN_INST, EXAMPLE_SCEN_STEP_SCEN, FMM_TABLE, GENERAL_ADD_LANG, GENERAL_BIND_MIN_ALLOW, GENERAL_BINDING, GENERAL_BINDING_NO_DESC, GENERAL_BINDING_NO_VS, GENERAL_CARD, GENERAL_CARDINALITY, GENERAL_CODE, GENERAL_COMMENT, GENERAL_COMMENTS, GENERAL_COMPARATORS, GENERAL_COMPONENT, GENERAL_CONFORMANCE, GENERAL_CONTACT, GENERAL_CONTENT, GENERAL_COPYRIGHT, GENERAL_CRIT, GENERAL_DATA_DISPLAY_PROPERTY, GENERAL_DEFINING_URL, GENERAL_DEFINITION, GENERAL_DEFINITION_COLON, GENERAL_DESC, GENERAL_DESC_CONST, GENERAL_DETAILS, GENERAL_DOCUMENTATION, GENERAL_EXAMPLE, GENERAL_EXPER, GENERAL_FILTER, GENERAL_FLAGS, GENERAL_LOCATION, GENERAL_LOGICAL_NAME, GENERAL_MAX_LENGTH, GENERAL_MODIFIERS, GENERAL_NAME, GENERAL_NCI_THES, GENERAL_NOTE, GENERAL_OBLIG, GENERAL_OID, GENERAL_PAR, GENERAL_PARS, GENERAL_PREFERRED, GENERAL_PROF, GENERAL_PROPS, GENERAL_PURPOSE, GENERAL_REFS, GENERAL_REMOVED_SINCE, GENERAL_REQUEST, GENERAL_REQUIRED, GENERAL_RESOURCE, GENERAL_SECURITY_LABEL, GENERAL_SRC, GENERAL_STARTER, GENERAL_STATUS, GENERAL_SUBJ, GENERAL_SUMM, GENERAL_TITLE, GENERAL_TODO, GENERAL_TYPE, GENERAL_UCUM, GENERAL_URI, GENERAL_URL, GENERAL_USAGE, GENERAL_VALUE, GENERAL_VALUESET, GENERAL_VER, GENERAL_VER_LOW, GENERAL_XML, IMP_GUIDE_URL, IP_INTRO, IP_NONE, IP_NONE_EXT, KIND_EXTENSION, KIND_LOGICAL, KIND_PROFILE, LIB_REND_ART, LIB_REND_AUT, LIB_REND_CONT, LIB_REND_ED, LIB_REND_END, LIB_REND_NOCONT, LIB_REND_PAR, LIB_REND_REQ, LIB_REND_REV, LIB_REND_SHOW, LIB_REND_SIZE, LIST_REND_CODE, LIST_REND_DAT, LIST_REND_DATE, LIST_REND_DEL, LIST_REND_ENC, LIST_REND_FLAG, LIST_REND_ITEM, LIST_REND_MODE, LIST_REND_ORD, LIST_REND_STAT, LIST_REND_SUB, LIST_SUMMARY, LIST_UNSPECIFIED_CODE, LIST_UNSPECIFIED_SUBJECT, MAP_DEFAULT_COMMENT, MATURITY_MATURITY, MATURITY_PUBLISHER, MATURITY_STATUS, MATURITY_STDS_STATUS, NAME_SYS_IDEN, NAME_SYS_PER, OBLIG_ACT, OBLIG_ELE, OP_DEF_INPAR, OP_DEF_OFFIC, OP_DEF_OUTPAR, OP_DEF_SCO, OP_DEF_URL, OP_DEF_URLS, OP_DEF_USE, OP_OUT_DIAG, OP_OUT_OK, OP_OUT_SEV, OP_OUT_SRC, OP_OUT_SUMM, OP_OUT_SUMM_ALL_OK, OP_OUT_SUMM_NOHINT, PARS_SUMMARY_LIST, PARS_SUMMARY_SIZE, PAT_ACTIVE, PAT_ACTIVE_HINT, PAT_ALT_NAME, PAT_ALT_NAME_HINT, PAT_CONTACT, PAT_CONTACT_HINT, PAT_CONTAINED, PAT_DECEASED, PAT_DECEASED_HINT, PAT_DOB, PAT_GENDER, PAT_GP, PAT_LANG, PAT_LANG_HINT, PAT_LANG_PREFERRED, PAT_LINK_REFER, PAT_LINK_REPL, PAT_LINK_REPLBY, PAT_LINK_SEE, PAT_LINKS, PAT_LINKS_HINT, PAT_MARITAL, PAT_MARITAL_HINT, PAT_MO, PAT_MUL_BIRTH, PAT_MUL_BIRTH_HINT, PAT_NO_DOB, PAT_NO_GENDER, PAT_NO_NAME, PAT_NOK_CONTACT_HINT, PAT_NOM_CONTACT, PAT_ORG, PAT_OTHER_ID, PAT_OTHER_ID_HINT, PAT_PERIOD, PAT_PHOTO, PAT_RELN, PROF_DRIV_ERR_GEN_NARR, PROF_DRIV_EXCP, PROF_DRIV_FEXCP, PROF_DRIV_GEN_NARR, PROF_DRIV_GEN_NARR_TECH, PROF_DRIV_SUMM, PROF_DRIV_SUMM_NONE, PROF_DRIV_SUMM_PROP, PROV_ACT, PROV_AGE, PROV_BEHALF, PROV_FOR, PROV_OCC, PROV_POL, PROV_PROV, PROV_PROVE, PROV_REC, PROV_ROLE, PROV_WHO, QUEST_ADD_INFO, QUEST_ALLOWED, QUEST_ANSW, QUEST_ANSWER, QUEST_ANSWERS, QUEST_APP, QUEST_ARE_TRUE, QUEST_ATTRIBUTES, QUEST_CALC, QUEST_CAND, QUEST_CAT, QUEST_CONT, QUEST_DERIVED, QUEST_DISPLAY, QUEST_DISPLAY_CAT, QUEST_EFF_PERIOD, QUEST_EN, QUEST_ENABLE, QUEST_EXP, QUEST_GROUP, QUEST_HIDDEN, QUEST_HIDDEN_ITEM, QUEST_ID, QUEST_INITIAL, QUEST_INITIAL_ANSWER, QUEST_INITIALLY, QUEST_INT, QUEST_ITEM, QUEST_ITEM_CONT, QUEST_LINK, QUEST_LINKED, QUEST_LINKID, QUEST_MAND, QUEST_MAX_LENGTH, QUEST_NLM, QUEST_NONE_SPEC, QUEST_OBSERVATION, QUEST_OPT, QUEST_OPTIONS, QUEST_ORIENTATION, QUEST_PREFIX, QUEST_PUB, QUEST_QUEST, QUEST_QUESTION, QUEST_READ_ONLY, QUEST_READONLY, QUEST_REP, QUEST_RESP_ROOT, QUEST_REV_DATE, QUEST_ROOT, QUEST_STRUCT, QUEST_SUB_TYPE, QUEST_SUBJECT, QUEST_SUMMARY, QUEST_TEXT, QUEST_TEXTFOR, QUEST_TIMES, QUEST_TRUE, QUEST_TRY, QUEST_TRY_QUEST, QUEST_TYPE_ITEM, QUEST_UNKNOWN_MODE, QUEST_UNSPECIFIED_QUESTIONNAIRE, QUEST_UNSPECIFIED_SUBJECT, QUEST_VALUE, REND_ADDED, REND_CHANGED, REND_REMOVED, REND_ROW_CHANGED_SINCE_WAS, REND_ROW_SINCE, REND_SINCE_ADDED, REND_SINCE_CHANGED, REND_SINCE_CHANGED_WAS, REND_STANDARDS, REQ_ACTOR, REQ_DERIVE, REQ_DERIVED, REQ_FOLLOWING_ACTOR, REQ_FOLLOWING_REQ, REQ_LINKS, REQ_SATISFIED, RES_REND_ACT, RES_REND_COND_REF, RES_REND_DESC, RES_REND_DRAFT, RES_REND_ERROR, RES_REND_INFO_SOURCE, RES_REND_LANGUAGE, RES_REND_RET, RES_REND_SEE_ON_THIS_PAGE, RES_REND_SPEC_RULES, RES_REND_TAG, RES_REND_UNKNOWN, RES_REND_UPDATED, RES_REND_VER, RESOURCE_COPYRIGHT, SD_COMP_HEAD_CARD_L, SD_COMP_HEAD_CARD_L_DESC, SD_COMP_HEAD_CARD_R, SD_COMP_HEAD_CARD_R_DESC, SD_COMP_HEAD_COMP_DESC, SD_COMP_HEAD_DESC_L, SD_COMP_HEAD_DESC_L_DESC, SD_COMP_HEAD_DESC_R, SD_COMP_HEAD_DESC_R_DESC, SD_COMP_HEAD_FLAGS_L, SD_COMP_HEAD_FLAGS_L_DESC, SD_COMP_HEAD_FLAGS_R, SD_COMP_HEAD_FLAGS_R_DESC, SD_COMP_HEAD_TYPE_L, SD_COMP_HEAD_TYPE_L_DESC, SD_COMP_HEAD_TYPE_R, SD_COMP_HEAD_TYPE_R_DESC, SD_DOCO, SD_GRID_HEAD_CARD_DESC, SD_GRID_HEAD_DESC, SD_GRID_HEAD_DESC_DESC, SD_GRID_HEAD_NAME_DESC, SD_GRID_HEAD_TYPE_DESC, SD_HEAD_CARD_DESC, SD_HEAD_DESC_DESC, SD_HEAD_FLAGS_DESC, SD_LEGEND, SD_SLICING_INFO, SD_SUMMARY_FIXED, SD_SUMMARY_MANDATORY, SD_SUMMARY_MAPPINGS, SD_SUMMARY_MISSING_EXTENSION, SD_SUMMARY_MISSING_PROFILE, SD_SUMMARY_MUST_SUPPORT, SD_SUMMARY_NESTED_MANDATORY, SD_SUMMARY_PROHIBITED, SD_SUMMARY_PUBLICATION, SD_SUMMARY_SLICE, SD_SUMMARY_SLICE_NONE, SD_SUMMARY_SLICES, SEARCH_PAR_ALLOWED, SEARCH_PAR_CHAIN, SEARCH_PAR_EXP, SEARCH_PAR_MULTIPLE_AND_APPEAR, SEARCH_PAR_MULTIPLE_AND_REPEAT, SEARCH_PAR_MULTIPLE_AND_SERVER, SEARCH_PAR_MULTIPLE_OR_MULTIPLE, SEARCH_PAR_MULTIPLE_OR_ONE, SEARCH_PAR_MULTIPLE_OR_SERVER, SEARCH_PAR_MULTIPLES, SEARCH_PAR_NONE, SEARCH_PAR_PROC, SEARCH_PAR_REND_TARGET, SEARCH_PAR_RES, STRUC_DEF_ABSTRACT, STRUC_DEF_ACT, STRUC_DEF_AFFECT_CONSTRAINTS, STRUC_DEF_ALL_ACTORS, STRUC_DEF_ALL_MAP_KEY, STRUC_DEF_ALL_SLICES, STRUC_DEF_ALL_TYPES, STRUC_DEF_ALLOWED, STRUC_DEF_ALT_NAME, STRUC_DEF_AND, STRUC_DEF_APPROP_CON, STRUC_DEF_AS_SHOWN, STRUC_DEF_BECAUSE, STRUC_DEF_BINDING_STYLE, STRUC_DEF_BINDINGS, STRUC_DEF_BLACK, STRUC_DEF_BUSINESS_ID, STRUC_DEF_BUSINESS_VERID, STRUC_DEF_CAN_TARGET, STRUC_DEF_CAND, STRUC_DEF_CAND_SUB, STRUC_DEF_CANNOT_TARGET, STRUC_DEF_CANT_FIND, STRUC_DEF_CAP, STRUC_DEF_CDA, STRUC_DEF_CHILD, STRUC_DEF_CHOICE, STRUC_DEF_CHOICE_DATA_TYPE, STRUC_DEF_CHOICE_GRP, STRUC_DEF_CHOICE_OF, STRUC_DEF_CLOSED, STRUC_DEF_COMMENT, STRUC_DEF_COMP_DOC, STRUC_DEF_COMP_EX, STRUC_DEF_COMP_PROF, STRUC_DEF_COMPLEX, STRUC_DEF_COMPLEXBRACK, STRUC_DEF_CONC_SET, STRUC_DEF_CONSTRAINING, STRUC_DEF_CONSTRAINTS, STRUC_DEF_CONT_RULE, STRUC_DEF_CONT_TYPE, STRUC_DEF_CONTROL, STRUC_DEF_COPY_URL, STRUC_DEF_CURR, STRUC_DEF_CURR_RULE, STRUC_DEF_DATE, STRUC_DEF_DATE_FORM, STRUC_DEF_DEF_CODES, STRUC_DEF_DEFAULT_TYPE, STRUC_DEF_DEFAULT_VALUE, STRUC_DEF_DERIVED_PROFILE, STRUC_DEF_DESC_PROF, STRUC_DEF_DESCRIM, STRUC_DEF_DISCUSSION, STRUC_DEF_ELE, STRUC_DEF_ELE_AFFECTED, STRUC_DEF_ELE_INCLUDED, STRUC_DEF_ELE_MUST_SUPP, STRUC_DEF_ELE_READ, STRUC_DEF_ELEMENT, STRUC_DEF_ELEMENTS, STRUC_DEF_ERR_DESC, STRUC_DEF_ERROR, STRUC_DEF_EX_CODE, STRUC_DEF_EX_DESC, STRUC_DEF_EX_TYPE, STRUC_DEF_EX_URL, STRUC_DEF_EXAM, STRUC_DEF_EXT, STRUC_DEF_EXT_JSON, STRUC_DEF_EXT_STYLE, STRUC_DEF_EXTENSIBLE, STRUC_DEF_EXTENSIONS, STRUC_DEF_FHIR, STRUC_DEF_FHIR_EXCEP, STRUC_DEF_FII, STRUC_DEF_FIXED, STRUC_DEF_FIXED_VALUE, STRUC_DEF_FOR_CODE, STRUC_DEF_FURTHER_INFO, STRUC_DEF_GRADE, STRUC_DEF_ID, STRUC_DEF_ID_EXPECT, STRUC_DEF_ID_IS, STRUC_DEF_ID_MAY, STRUC_DEF_ID_NOT_ALLOW, STRUC_DEF_IF, STRUC_DEF_IMPOSE_PROFILE, STRUC_DEF_INFERRED_JSON, STRUC_DEF_INVAR, STRUC_DEF_INVARIANT, STRUC_DEF_JSON_ARRAY, STRUC_DEF_JSON_CAN_NAME, STRUC_DEF_JSON_CHILD, STRUC_DEF_JSON_EXT, STRUC_DEF_JSON_FORM, STRUC_DEF_JSON_IF, STRUC_DEF_JSON_INFERRED, STRUC_DEF_JSON_IS, STRUC_DEF_JSON_MAY, STRUC_DEF_JSON_MAY_PRESENT, STRUC_DEF_JSON_NAME, STRUC_DEF_JSON_NOT_PRESENT, STRUC_DEF_JSON_NULL, STRUC_DEF_JSON_PRESENT, STRUC_DEF_JSON_PROPERTY_NAME, STRUC_DEF_JSON_SINGLE, STRUC_DEF_JSON_TYPE, STRUC_DEF_LABEL, STRUC_DEF_LEAST_FOLLOW, STRUC_DEF_LOGICAL, STRUC_DEF_LOGICAL_CONT, STRUC_DEF_LOINC, STRUC_DEF_LOINC_CODE, STRUC_DEF_MAX, STRUC_DEF_MAX_MIN, STRUC_DEF_MAX_VALUE, STRUC_DEF_MEAN_MISS, STRUC_DEF_MIN, STRUC_DEF_MIN_VALUE, STRUC_DEF_MISSING_LINK, STRUC_DEF_MOD, STRUC_DEF_MODIF, STRUC_DEF_MODIFIER, STRUC_DEF_MUST_SUPPORT, STRUC_DEF_MUST_SUPPORT_TYPES, STRUC_DEF_NAMESPACE, STRUC_DEF_NO_DESCRIM, STRUC_DEF_NO_MAPPINGS, STRUC_DEF_NO_MUST_SUPPORT, STRUC_DEF_NO_SUMMARY, STRUC_DEF_NOT_MARK, STRUC_DEF_NOTE_X, STRUC_DEF_NULL_JSON, STRUC_DEF_OBLIG, STRUC_DEF_OBLIG_ADD, STRUC_DEF_OBLIG_ALL, STRUC_DEF_OBLIG_FROM, STRUC_DEF_OBLIG_SUPP, STRUC_DEF_ONE_OF, STRUC_DEF_OPEN, STRUC_DEF_OPEN_END, STRUC_DEF_ORDERED, STRUC_DEF_PATH, STRUC_DEF_PATHS, STRUC_DEF_PATT_VALUE, STRUC_DEF_PREF_CONT, STRUC_DEF_PREFERRED, STRUC_DEF_PREFIXED, STRUC_DEF_PRIM_ELE, STRUC_DEF_PRIM_TYPE_PRESENT, STRUC_DEF_PRIM_TYPE_VALUE, STRUC_DEF_PRIMITIVE, STRUC_DEF_PROF_COMP, STRUC_DEF_PROF_REQ, STRUC_DEF_PROF_RES, STRUC_DEF_PROF_SUPP, STRUC_DEF_PROFILE_BUILDS, STRUC_DEF_PROFILED, STRUC_DEF_PROPERTY, STRUC_DEF_REFER_PROFILE, STRUC_DEF_REFERS_EXT, STRUC_DEF_REND_UNABLE_RES, STRUC_DEF_REPEAT, STRUC_DEF_REPEAT_ELE, STRUC_DEF_REQ_BIND, STRUC_DEF_REQ_PATT, STRUC_DEF_REQUIRED, STRUC_DEF_REQUIRED_PATT, STRUC_DEF_REQUIREMENTS, STRUC_DEF_ROOT, STRUC_DEF_SEE, STRUC_DEF_SET_ARE, STRUC_DEF_SET_SLICES, STRUC_DEF_SHALL_CODE, STRUC_DEF_SHORT, STRUC_DEF_SHOULD_CODE, STRUC_DEF_SINGLE_JSON_OBJECTS, STRUC_DEF_SLIC, STRUC_DEF_SLICE, STRUC_DEF_SLICE_FOR, STRUC_DEF_SLICE_NAME, STRUC_DEF_SLICE_PAR, STRUC_DEF_SLICES, STRUC_DEF_SNOMED, STRUC_DEF_SNOMED_CODE, STRUC_DEF_STAND_STAT, STRUC_DEF_STAND_STATUS, STRUC_DEF_STRING_FORM, STRUC_DEF_STRUCTURES, STRUC_DEF_SUIT_SHALL_CODE, STRUC_DEF_TARG_SUPP, STRUC_DEF_TEMPLATEID, STRUC_DEF_TERM_BIND, STRUC_DEF_TERM_BINDS, STRUC_DEF_THEN_TYPE, STRUC_DEF_THIS_REFERS, STRUC_DEF_TYPE_BOUND, STRUC_DEF_TYPE_PARAMETER, STRUC_DEF_TYPE_SET, STRUC_DEF_TYPE_SPEC, STRUC_DEF_TYPE_SUPP, STRUC_DEF_UI, STRUC_DEF_UI_CONT, STRUC_DEF_UNADORNED, STRUC_DEF_UNDEF_ACT, STRUC_DEF_UNKNOWN_APPROACH, STRUC_DEF_UNKNOWN_REF, STRUC_DEF_UNORDERED, STRUC_DEF_UNSPECIFIED, STRUC_DEF_URLS, STRUC_DEF_VALID, STRUC_DEF_VALUE_ALT, STRUC_DEF_VALUE_REQ, STRUC_DEF_VALUESET, STRUC_DEF_VALUESET_CODE, STRUC_DEF_WHAT, STRUC_DEF_XHTML, STRUC_DEF_XML_ACTUAL, STRUC_DEF_XML_ATTRIBUTE, STRUC_DEF_XML_ELE, STRUC_DEF_XML_FORM, STRUC_DEF_XML_NAME, STRUC_DEF_XSI, SUB_TOPIC_CREATE, SUB_TOPIC_DELETE, SUB_TOPIC_EVENT, SUB_TOPIC_FHIR_PATH, SUB_TOPIC_FILT_DEF, SUB_TOPIC_FILT_PAR, SUB_TOPIC_INCL, SUB_TOPIC_INT, SUB_TOPIC_PREV, SUB_TOPIC_REQ, SUB_TOPIC_RES_TRIG, SUB_TOPIC_REV_INCL, TERM_REND_COPY, TERMINOLOGY_LVL, TEST_PLAN_ASS, TEST_PLAN_ASSERTION, TEST_PLAN_CASE, TEST_PLAN_CASE_SEQ, TEST_PLAN_CATEGORY, TEST_PLAN_DATA, TEST_PLAN_DEP, TEST_PLAN_DEPEN, TEST_PLAN_DESC, TEST_PLAN_LANG, TEST_PLAN_RESULT, TEST_PLAN_RUN, TEST_PLAN_SCOPE, TEST_PLAN_SCOPES, TEST_PLAN_SOURCE, TEST_PLAN_TEST_DATA, TEST_PLAN_TEST_RUN, TEXT_ICON_CHOICE, TEXT_ICON_DATATYPE, TEXT_ICON_ELEMENT, TEXT_ICON_EXTENSION_COMPLEX, TEXT_ICON_EXTENSION_SIMPLE, TEXT_ICON_KEY, TEXT_ICON_OBJECT_BOX, TEXT_ICON_PRIMITIVE, TEXT_ICON_REFERENCE, TEXT_ICON_REUSE, TEXT_ICON_SLICE, TEXT_ICON_SLICE_ITEM, TX_DISPLAY, VALUE_SET_ADD_DESIG, VALUE_SET_ALL_CODE, VALUE_SET_ALL_CODES_DEF, VALUE_SET_AND, VALUE_SET_AUS, VALUE_SET_CODE_ITEM, VALUE_SET_CODE_SELEC, VALUE_SET_CODES_FROM, VALUE_SET_COMMA, VALUE_SET_CONT, VALUE_SET_CONT_STRUC, VALUE_SET_CONTAINS, VALUE_SET_CONTAINS_AT_LEAST, VALUE_SET_DANISH, VALUE_SET_DESCENDENTOF, VALUE_SET_DESIG, VALUE_SET_DISPLAY_ITEM, VALUE_SET_DOESNT_EXIST, VALUE_SET_DUTCH, VALUE_SET_EQUAL, VALUE_SET_ERROR, VALUE_SET_EXCL, VALUE_SET_EXCLUDED_FROM, VALUE_SET_EXISTS, VALUE_SET_EXP, VALUE_SET_EXP_FRAG, VALUE_SET_EXPANSION, VALUE_SET_EXPANSIONS, VALUE_SET_GENERALIZES, VALUE_SET_HAS, VALUE_SET_HAS_AT_LEAST, VALUE_SET_IMPORT, VALUE_SET_IN, VALUE_SET_INACT, VALUE_SET_INACTIVE, VALUE_SET_INC, VALUE_SET_INCLUDED_INTO, VALUE_SET_INT, VALUE_SET_ISA, VALUE_SET_ISNOTA, VALUE_SET_LEVEL, VALUE_SET_LOINCV, VALUE_SET_NO_VER, VALUE_SET_NO_VERSION, VALUE_SET_NOT_DEF, VALUE_SET_NOT_FOUND, VALUE_SET_NOTE, VALUE_SET_NOTIN, VALUE_SET_NULL, VALUE_SET_NULLS, VALUE_SET_NUMBER_CONCEPTS, VALUE_SET_REGEX, VALUE_SET_RULES_EXC, VALUE_SET_RULES_INC, VALUE_SET_SEL, VALUE_SET_SNOMED, VALUE_SET_SNOMED_ADD, VALUE_SET_SPAN, VALUE_SET_SPEC_NAME, VALUE_SET_SWEDISH, VALUE_SET_SYNONYM, VALUE_SET_SYSTEM, VALUE_SET_THESE_CODES_DEF, VALUE_SET_TOO_COSTLY, VALUE_SET_UK, VALUE_SET_US, VALUE_SET_USED_ELSEWHERE, VALUE_SET_WHERE, VALUE_SET_WHERE_CODES, VS_ABSTRACT_CODE_HINT
Fields inherited from class org.hl7.fhir.utilities.i18n.I18nBase
KEY_DELIMITER, locale, PLURAL_SUFFIX
-
Constructor Summary
ConstructorDescriptionRenderingContext
(IWorkerContext worker, org.hl7.fhir.utilities.MarkDownProcessor markdown, org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions, String specLink, String localPrefix, Locale locale, RenderingContext.ResourceRendererMode mode, RenderingContext.GenerationRules rules) -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addLink
(RenderingContext.KnownLinkType type, String link) void
copy
(boolean copyAnchors) fixReference
(String ref) int
In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.org.hl7.fhir.utilities.StandardsStatus
getFiles()
int
org.hl7.fhir.utilities.MarkDownProcessor
getMode()
getPkp()
getRules()
org.hl7.fhir.utilities.FhirPublication
org.hl7.fhir.utilities.validation.ValidationOptions
if the timezone is null, the rendering will default to the source timezone in the resource Note that if you're working server side, the FHIR project recommends the use of the Date header so that clients know what timezone the server defaults to, There is no standard way for the server to know what the client timezone is.getTranslated
(PrimitiveType<?> t) getTranslatedCode
(String code, String codeSystem) getTranslatedCode
(Element e, String codeSystem) getTranslatedCode
(Base b, String codeSystem) getTranslatedCode
(Enumeration<?> e, String codeSystem) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isPretty()
boolean
boolean
boolean
boolean
boolean
boolean
prefixAnchor
(String anchor) prefixLocalHref
(String url) void
setAddName
(boolean addName) void
setBase64Limit
(int base64Limit) setCanonicalUrlsAsLinks
(boolean canonicalUrlsAsLinks) setChangeVersion
(String changeVersion) setCodeSystemPropList
(List<String> codeSystemPropList) setContained
(boolean contained) setCopyButton
(boolean copyButton) setDateFormat
(DateTimeFormatter dateFormat) setDateFormatString
(String dateFormat) setDateTimeFormat
(DateTimeFormatter dateTimeFormat) setDateTimeFormatString
(String dateTimeFormat) setDateYearFormat
(DateTimeFormatter dateYearFormat) setDateYearFormatString
(String dateYearFormat) setDateYearMonthFormat
(DateTimeFormatter dateYearMonthFormat) setDateYearMonthFormatString
(String dateYearMonthFormat) setDefaultStandardsStatus
(org.hl7.fhir.utilities.StandardsStatus defaultStandardsStatus) setDefinitionsTarget
(String definitionsTarget) setDestDir
(String destDir) void
setFixedFormat
(RenderingContext.FixedValueFormat fixedFormat) setHeaderLevelContext
(int headerLevelContext) setInlineGraphics
(boolean inlineGraphics) setLocalPrefix
(String localPrefix) void
setMultiLanguagePolicy
(RenderingContext.MultiLanguagePolicy multiLanguagePolicy) setNoSlowLookup
(boolean noSlowLookup) setPretty
(boolean pretty) setProfileUtilities
(ProfileUtilities profileUtilities) setQuestionnaireMode
(RenderingContext.QuestionnaireRendererMode questionnaireMode) setResolver
(Resolver.IReferenceResolver resolver) setScenarioMode
(RenderingContext.ExampleScenarioRendererMode scenarioMode) void
setSecondaryLang
(boolean secondaryLang) setServices
(FHIRPathEngine.IEvaluationContext services) void
setShortPatientForm
(boolean shortPatientForm) setShowComments
(boolean showComments) setShowSummaryTable
(boolean header) setStructureMode
(RenderingContext.StructureDefinitionRendererMode structureMode) setTargetVersion
(org.hl7.fhir.utilities.FhirPublication targetVersion) setTemplateProvider
(RenderingContext.ILiquidTemplateProvider templateProvider) setTerminologyServiceOptions
(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions) setTimeZoneId
(ZoneId timeZoneId) void
setUniqueLocalPrefix
(String uniqueLocalPrefix) void
setUnknownLocalReferencesNotLinks
(boolean unknownLocalReferencesNotLinks) toStr
(int v) withLocale
(Locale locale) withLocaleCode
(String locale) withUniqueLocalPrefix
(String uniqueLocalPrefix) Methods inherited from class org.hl7.fhir.utilities.i18n.RenderingI18nContext
formatPhrase, formatPhrasePlural, getMessagesSourceFileName, typeOfString
Methods inherited from class org.hl7.fhir.utilities.i18n.I18nBase
formatMessage, formatMessagePlural, getLocale, getPluralKey, getPluralKeys, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, messageKeyExistsForLocale, setLocale, setPluralRules, setValidationMessageLanguage, setWarnAboutMissingMessages
-
Constructor Details
-
RenderingContext
public RenderingContext(IWorkerContext worker, org.hl7.fhir.utilities.MarkDownProcessor markdown, org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions, String specLink, String localPrefix, Locale locale, RenderingContext.ResourceRendererMode mode, RenderingContext.GenerationRules rules) - Parameters:
markdown
- - appropriate markdown processing engineterminologyServiceOptions
- - options to use when looking up codesspecLink
- - path to FHIR specificationlocale
- - i18n for renderingcontext
- - access to all related resources that might be needed
-
-
Method Details
-
copy
-
getContext
-
getProfileUtilities
-
getWorker
-
isCanonicalUrlsAsLinks
-
setCanonicalUrlsAsLinks
-
getMarkdown
-
getMultiLanguagePolicy
-
setMultiLanguagePolicy
-
getAllowedLanguages
-
getLocalPrefix
-
getTerminologyServiceOptions
-
getHeaderLevelContext
-
setHeaderLevelContext
-
getResolver
-
setResolver
-
setTerminologyServiceOptions
public RenderingContext setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions) -
isNoSlowLookup
-
setNoSlowLookup
-
getDefinitionsTarget
-
setDefinitionsTarget
-
getDestDir
-
setDestDir
-
setProfileUtilities
-
getTemplateProvider
-
setTemplateProvider
public RenderingContext setTemplateProvider(RenderingContext.ILiquidTemplateProvider templateProvider) -
getServices
-
setServices
-
isPretty
-
setPretty
-
getParser
-
setParser
-
getCodeSystemPropList
-
setCodeSystemPropList
-
isInlineGraphics
-
setInlineGraphics
-
isShowSummaryTable
-
setShowSummaryTable
-
getScenarioMode
-
setScenarioMode
-
getQuestionnaireMode
-
setQuestionnaireMode
public RenderingContext setQuestionnaireMode(RenderingContext.QuestionnaireRendererMode questionnaireMode) -
getStructureMode
-
setStructureMode
public RenderingContext setStructureMode(RenderingContext.StructureDefinitionRendererMode structureMode) -
fixReference
-
setLocalPrefix
-
getTargetVersion
-
setTargetVersion
-
isTechnicalMode
-
getTimeZoneId
if the timezone is null, the rendering will default to the source timezone in the resource Note that if you're working server side, the FHIR project recommends the use of the Date header so that clients know what timezone the server defaults to, There is no standard way for the server to know what the client timezone is. In the case where the client timezone is unknown, the timezone should be null- Returns:
- the specified timezone to render in
-
setTimeZoneId
-
getDateTimeFormat
In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.- Returns:
- the format to use
-
setDateTimeFormat
-
setDateTimeFormatString
-
getDateFormat
In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.- Returns:
- the format to use
-
setDateFormat
-
setDateFormatString
-
getDateYearFormat
-
setDateYearFormat
-
setDateYearFormatString
-
getDateYearMonthFormat
-
setDateYearMonthFormat
-
setDateYearMonthFormatString
-
getMode
-
setMode
-
isContained
-
setContained
-
isShowComments
-
setShowComments
-
isCopyButton
-
setCopyButton
-
setPkp
-
getPkp
-
hasLink
-
getLink
-
addLink
-
getRules
-
setRules
-
getDefaultStandardsStatus
-
setDefaultStandardsStatus
public RenderingContext setDefaultStandardsStatus(org.hl7.fhir.utilities.StandardsStatus defaultStandardsStatus) -
getChangeVersion
-
setChangeVersion
-
getNamedLinks
-
registerFile
-
getFiles
-
getFixedFormat
-
setFixedFormat
-
isAddName
-
setAddName
-
getTypeMap
-
toStr
-
getTranslated
-
getTranslated
-
getTranslatedElement
-
getTranslatedCode
-
getTranslatedCode
-
getTranslatedCode
-
getTranslatedCode
-
withLocale
-
withLocaleCode
-
getContextUtilities
-
getBase64Limit
-
setBase64Limit
-
isShortPatientForm
-
setShortPatientForm
-
isSecondaryLang
-
setSecondaryLang
-
prefixAnchor
-
prefixLocalHref
-
getUniqueLocalPrefix
-
setUniqueLocalPrefix
-
withUniqueLocalPrefix
-
forContained
-
hasAnchor
-
addAnchor
-
getAnchors
-
clearAnchors
-
isUnknownLocalReferencesNotLinks
-
setUnknownLocalReferencesNotLinks
-