CDC configurations API
The configurations API from CDC — 15 operation(s) for configurations.
CDC configurations API is one of 14 APIs that CDC 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 API documentation.
This API exposes 19 operations across 15 paths, and defines 43 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against the base URL https://data.cdc.gov/resource.
19 operations
15 paths
43 schemas
3 DELETE3 GET3 PATCH8 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 19
Across 15 paths, the API surfaces 19 operations — 3 DELETE, 3 GET, 3 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
configurations 19
GET
/api/v1/configurations/
Get Configurations
POST
/api/v1/configurations/
Create Configuration
GET
/api/v1/configurations/{configuration_id}
Get Configuration
PUT
/api/v1/configurations/{configuration_id}/code-sets
Associate Condition Codeset With Configuration
DELETE
/api/v1/configurations/{configuration_id}/code-sets/{condition_id}
Remove Condition Codeset From Configuration
POST
/api/v1/configurations/{configuration_id}/custom-codes
Add Custom Code
PUT
/api/v1/configurations/{configuration_id}/custom-codes
Edit Custom Code
POST
/api/v1/configurations/{configuration_id}/custom-codes/upload
Upload Custom Codes Csv
POST
/api/v1/configurations/{configuration_id}/custom-codes/confirm
Confirm Upload Custom Codes Csv
DELETE
/api/v1/configurations/{configuration_id}/custom-codes/{system_key}/{code}
Delete Custom Code
POST
/api/v1/configurations/{configuration_id}/custom-codes/validate
Validate Custom Code
GET
/api/v1/configurations/{configuration_id}/export
Get Configuration Export
POST
/api/v1/configurations/test
Run Configuration Test
POST
/api/v1/configurations/{configuration_id}/sections
Insert Custom Section
DELETE
/api/v1/configurations/{configuration_id}/sections
Delete Custom Section
PATCH
/api/v1/configurations/{configuration_id}/sections
Update Section
PATCH
/api/v1/configurations/{configuration_id}/activate
Activate Configuration
PATCH
/api/v1/configurations/{configuration_id}/deactivate
Deactivate Configuration
POST
/api/v1/configurations/{configuration_id}/release-lock
Release Configuration Lock
Schemas 43
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are GetConfigurationResponse (19 properties), GetConfigurationResponseVersion (8 properties), DbConfigurationSectionProcessing (7 properties), SectionUpdateInput (6 properties). Each schema is shown below with its type and property counts.
DbSectionType
string
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…
UploadCustomCodesPreviewResponse
object
Validated CSV preview for delayed confirmation; only valid if preview.
4 properties
2 required
CustomCodes
object
Model for custom codes response, with systems bundled alongside codes for frontend display.
2 properties
2 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
DbNarrativeAction
string
ConfigurationCustomCodeResponse
object
Configuration response for custom code operations (add/edit/delete).
4 properties
4 required
UploadCustomCodesPreviewItem
object
Validated CSV row ready for confirmation.
5 properties
4 required
Body_runInlineConfigurationTest
object
2 properties
1 required
ConfigurationStatusUpdateResponse
object
Response model for updating the status a configuration.
2 properties
2 required
GetConfigurationsResponse
object
Model for a user-defined configuration.
3 properties
3 required
IncludedCondition
object
Model for a condition that is associated with a configuration.
5 properties
5 required
DbTotalConditionCodeCount
object
Total code count model.
3 properties
3 required
AssociateCodesetInput
object
Condition association input model.
1 property
1 required
LockedByUser
object
LockedByUser response to provide user information.
3 properties
3 required
GetConfigurationResponseVersion
object
Model representing a version of a configuration.
8 properties
8 required
SectionUpdateInput
object
Input model for updating a section's processing instructions.
6 properties
1 required
CreateConfigurationResponse
object
Configuration creation response model.
2 properties
2 required
ValidateCustomCodeInput
object
Input model when validating a config's custom code.
2 properties
2 required
DbConfigurationCustomCode
object
Custom code associated with a Configuration.
3 properties
3 required
AddCustomCodeInput
object
Input model for adding a custom code to a configuration.
3 properties
3 required
CreateConfigInput
object
Body required to create a new configuration.
1 property
1 required
AddSectionInput
object
Request body for adding a section.
2 properties
2 required
Condition
object
Model for a Condition.
5 properties
5 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…
UpdateCustomCodeInput
object
Input model when updating a config's custom code.
6 properties
6 required
ValidateCustomCodeResponse
object
Validation response model.
1 property
1 required
AssociateCodesetResponse
object
Response from adding a code set to a config.
3 properties
3 required
CodeSystemKey
string
ConfirmUploadCustomCodesInput
object
Payload used to confirm a previously validated CSV import.
1 property
1 required
DeleteSectionInput
object
Request body to delete a section.
1 property
1 required
DbCode
object
DB model for code stored in the codes table.
4 properties
4 required
UploadCustomCodesResponse
object
CSV response model. Errors are surfaced via the errors array.
4 properties
ValidationError
object
5 properties
3 required
HTTPValidationError
object
1 property
ConfigurationTestResponse
object
Model to represent the response provided to the client when in-line testing is run.
3 properties
3 required
CodeSystemIndex
object
DbSectionAction
string
GetConfigurationResponse
object
Model for a configration response.
19 properties
19 required
DbConfigurationStatus
string
UpdateSectionProcessingResponse
object
Section with information for a custom section update.
3 properties
3 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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from CDC 12
Other APIs CDC publishes across the network.
CDC WONDER API
CDC Environmental Public Health Tracking Network API
CDC Content Syndication API
PHIN VADS API
CDC app-notifications API
CDC code-systems API
CDC conditions API
CDC events API
CDC Query API
CDC Query Connector API OpenAPI 3.0 API
CDC releases API
CDC simulator API
#configurations