On this page:

36.0Enumerated Types

 

This page lists enumerated types used in requests/responses on the API.

36.0.1Node And Module Status

 

Descriptions below refer to module, but these status codes apply to node status as well.

STARTEDModule is currently running
STOPPEDModule is currently not running
START_REQUESTEDSomeone has requested that the module start but the cluster manager on the node where this module is installed has not yet acknlowledged the start; if a module remains in this state for an extended period of time it is likely that the cluster manager is not working correctly on the node
START_ACKNOWLEDGEDThe cluster manager is currently starting the module
FAILED_TO_STARTThe cluster manager failed to start the module
STOP_REQUESTEDSomeone has requested that the module stop; see note on START_REQUESTED
STOP_ACKNOWLEDGEDThe cluster manager is currently stopping the module
FAILED_TO_STOPThe cluster manager failed to stop the module
RESTART_REQUESTEDSomeone has requested that the module restart; see note on START_REQUESTED
RESTART_ACKNOWLEDGEDThe cluster manager is currently restarting the module
ARCHIVE_REQUESTEDSomeone has requested that the module be archived
ARCHIVE_ACKNOWLEDGEDThe cluster manager is currently archiving the module
ARCHIVEDModule is archived
FAILED_TO_ARCHIVEThe cluster manager failed to archive the module
REINSTATEMENT_REQUESTEDSomeone has requested that the module be reinstated
REINSTATEMENT_ACKNOWLEDGEDThe cluster manager is currently reinstating the module
FAILED_TO_REINSTATEThe cluster manager failed to reinstate the module

36.0.2Transaction Log Outcomes

 
SUCCESSTransaction Succeeded
FAILTransaction Failed

36.0.3Module Types

 
ADMIN_JSONJSON Admin API
ADMIN_WEBWeb Admin Console
CDA_EXCHANGECDA Exchange Endpoint
CHANNEL_IMPORTChannel Import
CLUSTER_MGRCluster Manager
EMPIEnterprise Patient Master Index
ENDPOINT_CDS_HOOKSCDS-Hooks Endpoint
ENDPOINT_FHIRWEBFHIRWeb Console
ENDPOINT_FHIR_GATEWAYFHIR REST Endpoint (R4)
ENDPOINT_FHIR_REST_DSTU2FHIR REST Endpoint (DSTU2)
ENDPOINT_FHIR_REST_DSTU3FHIR REST Endpoint (DSTU3)
ENDPOINT_FHIR_REST_R4FHIR REST Endpoint (R4)
ENDPOINT_HL7V2_INHL7 v2.x Listening Endpoint
ENDPOINT_HL7V2_OUTHL7 v2.x Sending Endpoint
ENDPOINT_HYBRID_PROVIDERSHybrid Providers Endpoint
ENDPOINT_PACKAGE_REGISTRYFHIR REST Endpoint (R4)
ENDPOINT_SUBSCRIPTION_WEBSOCKETSubscription Websocket Endpoint
ETL_IMPORTERETL Importer
MDMMaster Data Management
NARRATIVE_GENERATORNarrative Generator
PERSISTENCE_DSTU2FHIR Storage (DSTU2 Relational)
PERSISTENCE_DSTU3FHIR Storage (R3 Relational)
PERSISTENCE_MONGODBFHIR Storage (Mongo)
PERSISTENCE_R4FHIR Storage (R4 Relational)
REALTIME_EXPORTRealtime Export
SECURITY_IN_LDAPLDAP Inbound Security
SECURITY_IN_LOCALLocal Inbound Security
SECURITY_IN_SAMLSAML Inbound Security
SECURITY_IN_SCRIPTScripted Inbound Security
SECURITY_IN_SMARTSMART Inbound Security
SECURITY_OUT_SMARTSMART Outbound Security
SMART_APPS_HOSTSMART App Host
SUBSCRIPTION_MATCHERSubscription Matcher (All Versions)
SUBSCRIPTION_MATCHER_DSTU2Subscription Matcher (DSTU2 - Deprecated)
SUBSCRIPTION_MATCHER_DSTU3Subscription Matcher (DSTU3 - Deprecated)
SUBSCRIPTION_MATCHER_R4Subscription Matcher (R4 - Deprecated)
APP_GALLERYApp Management Tools