CDC DIBBs eCR Refiner API is one of 10 APIs that Centers for Disease Control and Prevention publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include eCR, eICR, HL7 CDA, Public Health Surveillance, and Reportable Conditions. The published artifact set on APIs.io includes an OpenAPI specification and a changelog.
This API exposes
44 operations
across 39 paths,
organized into 9 resource areas,
and defines 85 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
The identity and technical contract details declared by the specification.
AddCustomCodeInput
object
Input model for adding a custom code to a configuration.
3 properties
3 required
AddSectionInput
object
Request body for adding a section.
2 properties
2 required
AssociateCodesetInput
object
Condition association input model.
1 property
1 required
AssociateCodesetResponse
object
Response from adding a code set to a config.
3 properties
3 required
AuditEvent
object
An event returned by the DB function.
9 properties
9 required
Body_discoverConfigurations
object
1 property
Body_runInlineConfigurationTest
object
2 properties
1 required
Body_setCodesStatus
object
2 properties
2 required
Body_uploadEcr
object
2 properties
1 required
BulkDeleteCustomCodesInput
object
Input model for a bulk custom codes deletion request.
3 properties
3 required
CodeCategoryCompletenessStatus
object
Code category completeness status model.
3 properties
3 required
CodeCategoryStatus
string
CodeCountsResponse
object
Code count information to return to the client.
5 properties
5 required
CodeFilterOptions
object
Model to represent all filter options available to the client.
3 properties
3 required
CodeResponse
object
Code object to return to the client.
10 properties
10 required
CodeSystemFilterOption
object
Model to represent a code system filter option.
3 properties
3 required
CodeSystemsReponse
object
Display information needed for code system information on the frontend.
4 properties
4 required
CodedConcept
object
Code / display name minimal representation of a codeable concept.
2 properties
2 required
CodedDataLabels
object
Enum class to type the narrative actions possible for the frontend.
2 properties
CodesLimitResponse
object
Utility class to help Orval ship these values to the frontend.
1 property
CodesResponse
object
Codes and metadata to return to the client.
3 properties
3 required
CompletenessStatus
object
Condition completeness status model.
2 properties
2 required
Condition
object
Model for a Condition.
5 properties
5 required
ConfigurationStatusUpdateResponse
object
Response model for updating the status a configuration.
2 properties
2 required
ConfigurationTestResponse
object
Model to represent the response provided to the client when in-line testing is run.
3 properties
3 required
ConfirmUploadCustomCodesInput
object
Payload used to confirm a previously validated CSV import.
1 property
1 required
CreateConfigInput
object
Body required to create a new configuration.
1 property
1 required
CreateConfigurationResponse
object
Configuration creation response model.
2 properties
2 required
CustomCodeResponse
object
Custom code object to return to the client.
5 properties
5 required
CustomCodeUploadEventResponse
object
Response model for a custom code upload event.
4 properties
4 required
DbCode
object
Model for all coded information stored in the codes table.
4 properties
4 required
DbCodeSystem
object
A code system row from the systems table.
4 properties
4 required
DbConfigurationSectionProcessing
object
Section Processing instructions for a Configuration. name is the section's name. code is the LOINC code for the section. versions is a list of versions this se…
7 properties
7 required
DbConfigurationStatus
string
DbTotalConditionCodeCount
object
Total code count model.
3 properties
3 required
DeleteSectionInput
object
Request body to delete a section.
1 property
1 required
DisabledSection
string
These sections are preserved intact in every refined document. They sit outside the normal refinement workflow not because the refiner needs to protect them, b…
DiscoveredConfigurationSet
object
Model to represent a set of discovered configurations.
3 properties
3 required
DiscoveredConfigurationVersion
object
Model to represent individual discovered configurations.
3 properties
3 required
DiscoveredConfigurationsResponse
object
Model to represent the sets of discovered configurations to return to the client.
1 property
1 required
EventFilterOption
object
Conditions returned to the user to be used for filtering events.
3 properties
3 required
EventsResponse
object
Response needed for the audit log page.
3 properties
3 required
FileInfoResponse
object
Utility class to help Orval ship these values to the frontend.
2 properties
GetConditionResponse
object
Condition response model.
5 properties
5 required
GetConditionsResponse
object
Conditions response model.
3 properties
3 required
GetConfigurationResponse
object
Model for a configuration response.
19 properties
19 required
GetConfigurationResponseVersion
object
Model representing a version of a configuration.
8 properties
8 required
GetConfigurationsResponse
object
Model for a user-defined configuration.
3 properties
3 required
HTTPValidationError
object
1 property
IncludedCondition
object
Model for a condition that is associated with a configuration.
6 properties
6 required
LockedByUser
object
LockedByUser response to provide user information.
3 properties
3 required
NarrativeDataLabels
object
Enum class to type the narrative actions possible for the frontend.
4 properties
NarrativeOnlySection
string
These sections have no entry match rules in the eICR specification. They are conveyed via the narrative block only. Configuring them for "refine" is meaningles…
NotificationKeys
string
Enum class to type the values of the notifications possible for actioning on the frontend.
NotificationsToRender
object
Map of booleans for each of the notificaiton keys as to whether to render frontend banners.
1 property
1 required
ReconstructableSection
string
These sections support the "reconstruct" narrative action. Results, Problems, Immunizations, Medications Administered, and Plan of Treatment are enabled. Make…
Release
object
Type for release information sent to the frontend.
6 properties
6 required
ReleaseNotes
object
Content of a release note from GitHub.
3 properties
3 required
ReleasesResponse
object
Response for releases as returned through the GitHub API.
1 property
1 required
SectionUpdateInput
object
Input model for updating a section's processing instructions.
6 properties
1 required
SerializedFile
object
An individual serialized file.
2 properties
2 required
SerializedFiles
object
Dataclass for serialized file data.
3 properties
3 required
SimulatorUploadResponse
object
Model for the response when uploading a document in the simulate testing suite.
6 properties
6 required
SourceFilterOption
object
Model to represent a source filter option.
3 properties
3 required
StatusFilterOption
object
Model to represent a status filter option.
3 properties
3 required
TesConfigToUpdate
object
A configuration to update with new TES codes.
4 properties
4 required
TesConfigsToUpdateResponse
object
The response needed for rendering of the TES update configuration page.
2 properties
2 required
TesDiffConditionDetails
object
A condition within a TES diff, with details for the diff page to display.
5 properties
5 required
TesResponse
object
Response needed for the TES updates page.
1 property
1 required
TesUpdate
object
All metadata for a TES update needed for the frontend.
3 properties
3 required
TriggerCodeSection
string
These sections can carry an eICR trigger code template. The eICR IG defines trigger code templates for these sections, so a trigger code — the coded evidence o…
UpdateCustomCodeInput
object
Input model when updating a config's custom code.
4 properties
4 required
UpdateSectionProcessingResponse
object
Section with information for a custom section update.
7 properties
7 required
UpdateUserNotificationsRequest
object
Request to update notification acknowledgement state for the current user.
1 property
1 required
UploadCustomCodesCsvInput
object
Input model for Custom Code CSV.
2 properties
1 required
UploadCustomCodesPreviewItem
object
Validated CSV row ready for confirmation.
6 properties
5 required
UploadCustomCodesPreviewResponse
object
Validated CSV preview for delayed confirmation; only valid if preview.
4 properties
2 required
UserResponse
object
User information to send to the client.
4 properties
4 required
ValidateCustomCodeInput
object
Input model when validating a config's custom code.
2 properties
2 required
ValidateCustomCodeResponse
object
Validation response model.
1 property
1 required
ValidationError
object
5 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Centers for Disease Control and Prevention publishes across the network.
