Versions Compared

Old Version 2

changes.mady.by.user Pete Richardson

Saved on

compared with

New Version Current

changes.mady.by.user Pete Richardson

Saved on

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.

{ "person" : { "active":true, "birthDate":"19650521", "telecom":[ {"rank":2,"system":"phone","value":"(734)556-1212","use":"home"}, {"rank":1,"system":"email","value":"sdoh@yahoo.com","use":""}], "managingOrganization":"hfhs", "address":{"country":"US","city":"RIVERVIEW","use":"home","line":"6329 TEMPLATE","postalCode":"48192","county":"WAYNE","text":"6329 TEMPLATE RIVERVIEW, MI 48192","state":"MI","type":"both"}, "name":{"given":"ONE","text":"ONE TEMPLIN","family":"TEMPLIN","use":"official","prefix":"TEMPLIN"}, "gender":"male", "recordType":"FHIR", "language":"English", "personId":"8cb77503-e481-431a-a0d3-c0c156327504"} }, instance: "347984t9" }

 

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

DescriptionResponse Example

201

200

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