Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Scope Needed For This API

CIE SEMI Hub - cie-semi.hub/fhir-write

 

Rest URL

The following are the URLs for this API. Please note that base url for the region you are looking for can be found here Community Information Exchange Hub Region URL

...

The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. https://tools.ietf. org/html/rfc7807 . Please note that all responses will also include a instance value which will uniquely identify the specific request that was made. This ensures uniqueness even if the patient was referred to the CIE multiple times.

{ "entry": [ { "response": { "location": projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/RESOURCE/RESOURCE_ID, "status": "201 Created" } }, { "response": { "status": "200 OK" } } ], "resourceType": "Bundle", "type": "transaction-response" }

{ "type": "cie/unauthorized", "title": "Request is not authorized to perform this operation", "detail": "The x-api-key header may be missing or is invalid", "instance":"4abdf0d4-e934-5575513f6d5" }  

 

HTTP Status Code

Description

Response Example

200201

Successful Implementation of a transaction bundle.

 

Code Block

403

Request is unauthorized and will not be processed. This will happen if the authorization header does not contain a valid client id and secret.

 

 

Code Block

400

Request is malformed and will not be processed.

 

code

{ "type": "cie/validation-error", "title": "Your request parameters didn't validate.", "instance":"4abdf0d4-e934-5575513f6d5" }

 

Example CURL for this API Call

...

Code Block
curl -v 
--request POST 'https://fhir-dev.semi-cie.{baseCIEURL}.org/procedure/' 
--header 'x-api-key: aGZoczo4****2ZDk=' 
--header 'Content-Type: application/json' 
--header 'Authorization: bearer etty****iquerui'
 --data @BUNDLE_FILE.json \
 




...