Add a bundle of FHIR Resources to the server
The Bundle supplied in the multipart/form-data must be in either of FHIR's JSON or XML formats.
**Content-Type: ** application/json
Status Code | Reason | Response Model |
---|---|---|
200 | successful operation | Array[AtomArtifact] |
**Content-Type: ** application/json
Status Code | Reason | Response Model |
---|---|---|
200 | successful operation | Array[AtomArtifact] |
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
codeSystemId | query | yes | A code system identifier, e.g. http://snomed.info/sct | - | string |
codeSystemVersion | query | no | The version (or optionally, for SNOMED, the Edition) of the specified code system | - | string |
validate | query | yes | Indicates whether the server should validate the index if it already exists | - | boolean |
buildLocal | query | no | Do not use BINARY indexes from syndication feed, but build them locally | - | boolean |
**Content-Type: ** application/json
Status Code | Reason | Response Model |
---|---|---|
200 | successful operation | Array[CodeSystem] |
Loads RF2 content into the underlying database. Does not build an index - see /api/indexCodeSystem
Note: under consideration for deprecation
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
codeSystemId | query | yes | A code system identifier, e.g. http://snomed.info/sct | - | string |
codeSystemVersion | query | yes | The version of the specified code system | - | string |
indexVersion | query | yes | The internal version of the binary index format | - | string |
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
codeSystemId | query | yes | A code system identifier, e.g. http://snomed.info/sct | - | string |
codeSystemVersion | query | yes | The version of the specified code system | - | string |
syndicate | query | yes | Whether to publish a binary index for the code system | - | boolean |
name | type | required | description | example |
---|---|---|---|---|
codeSystem | CodeSystemReference | optional | - | |
type | string | optional | - | |
baseModule | string | optional | - | |
baseEffectiveTime | string | optional | - | |
indexVersion | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
zone | DateTimeZone | optional | - |
name | type | required | description | example |
---|---|---|---|---|
get_id | integer (int64) | optional | - | |
id | string | optional | - | |
lastUpdated | string (date-time) | optional | - | |
metaVersion | string | optional | - | |
jsonBlob | string | optional | - | |
tags | array[Tag] | optional | - | |
url | string | optional | - | |
version | string | optional | - | |
name | string | optional | - | |
description | string | optional | - | |
identifierSystem | string | optional | - | |
identifierValue | string | optional | - | |
valueSetUri | string | optional | - | |
indexStatus | string | optional | - | |
syndicate | boolean | optional | - | |
sha256 | string | optional | - | |
indexVersion | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
codeSystem | CodeSystemReference | optional | - | |
name | string | optional | - | |
sourceAvailable | boolean | optional | - | |
binaryAvailable | boolean | optional | - | |
inDatabase | boolean | optional | - | |
status | string | optional | - | |
syndicated | boolean | optional | - |
name | type | required | description | example |
---|---|---|---|---|
id | string | optional | - | |
url | string | optional | - | |
version | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
name | string | optional | - | |
type | DateTimeFieldType | optional | - | |
supported | boolean | optional | - | |
lenient | boolean | optional | - | |
minimumValue | integer (int32) | optional | - | |
maximumValue | integer (int32) | optional | - | |
rangeDurationField | DurationField | optional | - | |
leapDurationField | DurationField | optional | - | |
durationField | DurationField | optional | - |
name | type | required | description | example |
---|---|---|---|---|
name | string | optional | - | |
rangeDurationType | DurationFieldType | optional | - | |
durationType | DurationFieldType | optional | - |
name | type | required | description | example |
---|---|---|---|---|
id | string | optional | - | |
fixed | boolean | optional | - |
name | type | required | description | example |
---|---|---|---|---|
name | string | optional | - | |
type | DurationFieldType | optional | - | |
supported | boolean | optional | - | |
precise | boolean | optional | - | |
unitMillis | integer (int64) | optional | - |
name | type | required | description | example |
---|---|---|---|---|
name | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
era | integer (int32) | optional | - | |
dayOfYear | integer (int32) | optional | - | |
dayOfWeek | integer (int32) | optional | - | |
dayOfMonth | integer (int32) | optional | - | |
year | integer (int32) | optional | - | |
chronology | Chronology | optional | - | |
centuryOfEra | integer (int32) | optional | - | |
yearOfEra | integer (int32) | optional | - | |
yearOfCentury | integer (int32) | optional | - | |
weekyear | integer (int32) | optional | - | |
monthOfYear | integer (int32) | optional | - | |
weekOfWeekyear | integer (int32) | optional | - | |
hourOfDay | integer (int32) | optional | - | |
minuteOfHour | integer (int32) | optional | - | |
secondOfMinute | integer (int32) | optional | - | |
millisOfSecond | integer (int32) | optional | - | |
millisOfDay | integer (int32) | optional | - | |
fields | array[DateTimeField] | optional | - | |
values | array[integer] | optional | - | |
fieldTypes | array[DateTimeFieldType] | optional | - |
name | type | required | description | example |
---|---|---|---|---|
moduleId | string | optional | - | |
name | string | optional | - | |
effectiveTime | LocalDateTime | optional | - | |
dependencies | array[Module] | optional | - |
name | type | required | description | example |
---|---|---|---|---|
get_id | integer (int64) | optional | - | |
id | string | optional | - | |
lastUpdated | string (date-time) | optional | - | |
metaVersion | string | optional | - | |
jsonBlob | string | optional | - | |
tags | array[Tag] | optional | - |
name | type | required | description | example |
---|---|---|---|---|
get_id | integer (int64) | optional | - | |
id | string | optional | - | |
lastUpdated | string (date-time) | optional | - | |
metaVersion | string | optional | - | |
jsonBlob | string | optional | - | |
tags | array[Tag] | optional | - |
name | type | required | description | example |
---|---|---|---|---|
code | string | optional | - | |
system | string | optional | - | |
resource | ResourceObject | optional | - |