Versions Compared

Key

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

...

Info

Scope Needed For This API

CIE Michigan 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

Environment

URL

Development

POST https://fhir-dev.{cie-region}.org/procedureProcedure

UAT

POST https://fhir-uat.{cie-region}.org/procedureProcedure

Production

POST https://fhir.{cie-region}.org/procedureProcedure

Headers

The following will be headers that will need to be supplied

...

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.

 

403

HTTP Status Code

DescriptionResponse Example

201

Successful creation of a service request.

 

code

{
  "entry": {
    "id": "PROCEDURE_ID",
    "meta": {
      "lastUpdated": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ",
      "versionId": "VERSION_ID"
    },  
    // The rest of the object that was passed in
  },
  "instance": '938475914' // This is the unique instance id that references this transaction
}  

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
{
  "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"
}




 

 

400

Request is malformed and will not be processed.

 

Code Block
{
  "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/procedureProcedure/' 
--header 'x-api-key: aGZoczo4****2ZDk=' 
--header 'Content-Type: application/json' 
--header 'Authorization: bearer etty****iquerui'
 --data @PROCEDURE_FILE.json \