Centers for Disease Control and Prevention Configurations API is one of 19 APIs that Centers for Disease Control and Prevention publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Configurations. The published artifact set on APIs.io includes an OpenAPI specification and a changelog.
This API exposes
27 operations
across 22 paths,
and defines 55 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against the base URL https://data.cdc.gov/resource/.
The identity and technical contract details declared by the specification.
NarrativeDataLabels
object
Enum class to type the narrative actions possible for the frontend.
4 properties
GetConfigurationResponseVersion
object
Model representing a version of a configuration.
8 properties
8 required
ValidationError
object
5 properties
3 required
ConfigurationStatusUpdateResponse
object
Response model for updating the status a configuration.
2 properties
2 required
ConfirmUploadCustomCodesInput
object
Payload used to confirm a previously validated CSV import.
1 property
1 required
DbConfigurationStatus
string
CodeSystemFilterOption
object
Model to represent a code system filter option.
3 properties
3 required
IncludedCondition
object
Model for a condition that is associated with a configuration.
6 properties
6 required
CreateConfigInput
object
Body required to create a new configuration.
1 property
1 required
DbTotalConditionCodeCount
object
Total code count model.
3 properties
3 required
ConfigurationTestResponse
object
Model to represent the response provided to the client when in-line testing is run.
3 properties
3 required
ValidateCustomCodeResponse
object
Validation response model.
1 property
1 required
CodeResponse
object
Code object to return to the client.
10 properties
10 required
LockedByUser
object
LockedByUser response to provide user information.
3 properties
3 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
UpdateCustomCodeInput
object
Input model when updating a config's custom code.
4 properties
4 required
AssociateCodesetInput
object
Condition association input model.
1 property
1 required
Body_runInlineConfigurationTest
object
2 properties
1 required
UploadCustomCodesCsvInput
object
Input model for Custom Code CSV.
2 properties
1 required
DbCodeSystem
object
A code system row from the systems table.
4 properties
4 required
ReconstructableSection
string
These sections support the "reconstruct" narrative action. Results, Problems, Immunizations, Medications Administered, and Plan of Treatment are enabled. Make…
GetConfigurationsResponse
object
Model for a user-defined configuration.
3 properties
3 required
AddSectionInput
object
Request body for adding a section.
2 properties
2 required
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…
Condition
object
Model for a Condition.
5 properties
5 required
AddCustomCodeInput
object
Input model for adding a custom code to a configuration.
3 properties
3 required
HTTPValidationError
object
1 property
DeleteSectionInput
object
Request body to delete a section.
1 property
1 required
CodeCountsResponse
object
Code count information to return to the client.
5 properties
5 required
UpdateSectionProcessingResponse
object
Section with information for a custom section update.
7 properties
7 required
StatusFilterOption
object
Model to represent a status filter option.
3 properties
3 required
SourceFilterOption
object
Model to represent a source filter option.
3 properties
3 required
CodedDataLabels
object
Enum class to type the narrative actions possible for the frontend.
2 properties
AssociateCodesetResponse
object
Response from adding a code set to a config.
3 properties
3 required
SerializedFiles
object
Dataclass for serialized file data.
3 properties
3 required
SectionUpdateInput
object
Input model for updating a section's processing instructions.
6 properties
1 required
CustomCodeResponse
object
Custom code object to return to the client.
5 properties
5 required
SerializedFile
object
An individual serialized file.
2 properties
2 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
CreateConfigurationResponse
object
Configuration creation response model.
2 properties
2 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…
DbCode
object
Model for all coded information stored in the codes table.
4 properties
4 required
BulkDeleteCustomCodesInput
object
Input model for a bulk custom codes deletion request.
3 properties
3 required
CodesResponse
object
Codes and metadata to return to the client.
3 properties
3 required
CodeFilterOptions
object
Model to represent all filter options available to the client.
3 properties
3 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…
ValidateCustomCodeInput
object
Input model when validating a config's custom code.
2 properties
2 required
GetConfigurationResponse
object
Model for a configuration response.
19 properties
19 required
Body_setCodesStatus
object
2 properties
2 required
CodesLimitResponse
object
Utility class to help Orval ship these values to the frontend.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Centers for Disease Control and Prevention publishes across the network.
