Versions Compared

Old Version 3

changes.mady.by.user Pete Richardson

Saved on

compared with

New Version 4

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

...

HTTP Status Code

Description

Response Example

200201

Successful creation of a service request.

 

Code Block
{
  "personentry" : {
    "activeid":true,
    "birthDate":"19650521"PROCEDURE_ID",
    "telecommeta":[
      {"rank":2,"system":"phone","value":"(734)556-1212","use":"home"},
      {"ranklastUpdated":1,"system":"email","value":"sdoh@yahoo.com","use":""}],
    "managingOrganization":"hfhs", "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ",
      "address":{"country":"US","city":"RIVERVIEW","use":"home","line":"6329 TEMPLATE","postalCode":"48192","county":"WAYNE","text":"6329 TEMPLATE RIVERVIEW, MI  48192","state":"MI","type":"both"versionId": "VERSION_ID"
    },  
  "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"
}  
    



 // The rest of the object that was passed in
  },
  "instance": '938475914' // This is the unique instance id that references this transaction
}

 

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

 

...

The following is an example CURL for calling this api. Also note that there are sample Referral Id’s that are in the CIE Hub development environment that can be used for testing purposes

 

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

...