Create a custom schema (API Explorer) | Candid

AuthV2
- POSTGet token
Billing NotesV2
- POSTCreate billing note
- DELDelete billing note
- PATCHUpdate
Charge Capture BundlesV1
- GETGet Charge Capture Bundle
- GETGet Charge Capture Bundle Summary
- POSTResubmit a bundle to bundling logic.
- GETGet all Charge Capture Bundles
Charge CaptureV1
- POSTCreate a ChargeCapture
- DELDelete Charge Capture
- PATCHUpdate Charge Capture
- GETGet Charge Capture
- GETGet all Charge Captures
- PATCHUpdate a ChargeCapturePostBilledChange
ContractsV2
- GETGet contract
- GETGet all contracts
- POSTCreate contract
- DELDelete contract
- PATCHUpdate contract
CredentialingV2
- POSTCreate provider credentialing span
- GETGet provider credentialing span
- GETGet all provider credentialing spans
- DELDelete provider credentialing span
- PATCHUpdate provider credentialing span
Custom SchemasV1
- GETGet all custom schemas
- GETGet custom schema
- POSTCreate a custom schema
- PATCHUpdate custom schema
EligibilityV2
- POSTSubmit encounter eligibility check
- GETSubmit encounter eligibility check (Availity)
- POSTSubmit encounter eligibility check (Availity Post)
Encounter ProvidersV2
- PATCHUpdate Referring Provider
- PATCHUpdate Initial Referring Provider
- PATCHUpdate Supervising Provider
- PATCHUpdate Ordering Provider
- POSTCreate Referring Provider
- POSTCreate Initial Referring Provider
- POSTCreate Supervising Provider
- POSTCreate Ordering Provider
- DELDelete Referring Provider
- DELDelete Initial Referring Provider
- DELDelete Supervising Provider
- DELDelete Ordering Provider
EncountersV4
- GETGet all encounters
- GETGet encounter
- POSTCreate encounter
- POSTCreate encounter from pre-encounter patient and appointment
- PATCHUpdate encounter
Expected Network StatusV1
- POSTCompute network status
Expected Network StatusV2
- POSTCompute for rendering provider
- POSTCompute for all in-network providers
ExportsV3
- GETGet exports
External Payment Account ConfigV1
- GETGet Multi
Fee SchedulesV3
- GETGet Match
- GETTest Match
- GETGet Multi
- GETGet Unique Values For Dimension
- GETGet Rate History
- POSTUpload a fee schedule (a collection of rates)
- DELDelete a rate
- GETGet Payer Thresholds Default
- GETGet Payer Thresholds
- PUTSet Payer Threshold
GuarantorV1
- POSTCreate guarantor
- GETGet guarantor
- PATCHUpdate guarantor
Import InvoiceV1
- POSTImport Invoice
- GETGet Multi
- GETGet
- PATCHUpdate
Insurance AdjudicationsV1
- GETGet insurance adjudication
- POSTCreate insurance adjudication
- DELDelete insurance adjudication
Insurance PaymentsV1
- GETGet insurance payments
- GETGet insurance payment
Insurance RefundsV1
- GETGet insurance refunds
- GETGet insurance refund
- POSTCreate insurance refund
- PATCHUpdate
- DELDelete insurance refund
Medication DispenseV1
- POSTMedication Dispense Create
Non Insurance Payer PaymentsV1
- GETGet non-insurance payer payments
- GETGet non-insurance payer payment
- POSTCreate non-insurance payer payment
- PATCHUpdate
- DELDelete non-insurance payer payment
Non Insurance Payer RefundsV1
- GETGet non-insurance payer refunds refunds
- GETGet non-insurance payer refund
- POSTCreate non-insurance payer refund
- PATCHUpdate
- DELDelete non-insurance payer refund
Non Insurance PayersV1
- POSTCreate
- PATCHToggle Enablement
- GETGet Multi
- GETGet
- PATCHUpdate
- DELDelete
Organization Service FacilitiesV2
- GETGet organization service facility
- GETGet all organization service facilities
- POSTCreate organization service facility
- PATCHUpdate organization service facility
- DELDelete organization service facility
Organization ProvidersV3
- GETGet organization provider
- GETGet all organization providers
- POSTCreate organization provider
- PATCHUpdate organization provider
Patient PaymentsV4
- GETGet patient payments
- GETGet patient payment
- POSTCreate patient payment
- PATCHUpdate
- DELDelete patient payment
Patient RefundsV1
- GETGet patient refunds
- GETGet patient refund
- POSTCreate patient refund
- PATCHUpdate
- DELDelete patient refund
Payer Plan GroupsV1
- GETGet payer plan groups
- GETGet payer plan group
- POSTCreate a payer plan group
- PUTUpdate payer plan group
- PATCHDelete payer plan group
PayersV3
- GETGet payer
- GETGet all payers
Service LinesV2
- POSTCreate Service Line
- PATCHUpdate Service Line
- DELDelete Service Line
TasksV3
- GETGet task actions
- GETGet all tasks
- GETGet task
- POSTCreate task
- PATCHUpdate task
Write OffsV1
- GETGet all write-offs
- GETGet write-off
- POSTCreate write-off
- POSTRevert write-off
- POSTRevert Insurance Balance Adjustment
- POSTRevert ERA-originated Insurance Balance Adjustment
Pre EncounterAppointmentsV1
- POSTCreate
- GETGet Visits
- GETGet
- GETGet History
- PUTUpdate
- GETScan
- DELDeactivate
Pre EncounterCoveragesV1
- POSTCreate
- PUTUpdate
- GETGet Multi Paginated
- GETGet
- GETGet History
- GETGet Multi
- GETScan
- POSTCheck Eligibility
- GETGet Eligibility
Pre EncounterEligibility ChecksV1
- POSTPost
Pre EncounterImagesV1
- POSTCreate
- GETGet
- PUTUpdate
- DELDeactivate
- GETGet Multi
Pre EncounterListsV1
- GETGet Patient List
- GETGet Appointment List
Pre EncounterNotesV1
- GETGet
- POSTCreate
- PUTUpdate
- DELDeactivate
Pre EncounterPatientsV1
- POSTCreate
- POSTCreate With Mrn
- GETGet Multi
- GETSearch Providers
- GETGet
- GETGet History
- PUTUpdate
- DELDeactivate
- PATCHReactivate
- GETSearch
- GETScan
Pre EncounterTagsV1
- GETGet
- GETGet All
- POSTCreate
- PUTUpdate
- DELDeactivate
Diagnoses
- POSTCreate diagnosis
- PATCHUpdate diagnosis
- DELDelete diagnosis
Service Facility
- PATCHUpdate

POST/api/custom-schemas/v1

Body Parameters

namestringRequired
fieldslist of objectsRequired(4 items)
- 1
  keystringRequired
  typeenumRequired
- 2
  keystringRequired
  typeenumRequired
- 3
  keystringRequired
  typeenumRequired
- 4
  keystringRequired
  typeenumRequired
descriptionstring

Request

$ curl -X POST https://api.joincandidhealth.com/api/custom-schemas/v1 \
>      -H "Authorization: Bearer " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "General Medicine",
>   "fields": [
>     {
>       "key": "provider_category",
>       "type": "STRING"
>     },
>     {
>       "key": "is_urgent_care",
>       "type": "BOOLEAN"
>     },
>     {
>       "key": "bmi",
>       "type": "DOUBLE"
>     },
>     {
>       "key": "age",
>       "type": "INTEGER"
>     }
>   ],
>   "description": "Values associated with a generic visit"
> }'

Response

$	curl -X POST https://api.joincandidhealth.com/api/custom-schemas/v1 \
>	-H "Authorization: Bearer " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "General Medicine",
>	"fields": [
>	{
>	"key": "provider_category",
>	"type": "STRING"
>	},
>	{
>	"key": "is_urgent_care",
>	"type": "BOOLEAN"
>	},
>	{
>	"key": "bmi",
>	"type": "DOUBLE"
>	},
>	{
>	"key": "age",
>	"type": "INTEGER"
>	}
>	],
>	"description": "Values associated with a generic visit"
>	}'